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;
26 cs->flags = CLIB_SOCKET_F_IS_CLIENT | CLIB_SOCKET_F_SEQPACKET;
28 wrk->vcl_needs_real_epoll = 1;
30 if ((err = clib_socket_init (cs)))
32 clib_error_report (err);
39 wrk->vcl_needs_real_epoll = 0;
45 vcl_api_attach_reply_handler (app_sapi_attach_reply_msg_t * mp, int *fds)
47 vcl_worker_t *wrk = vcl_worker_get_current ();
48 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 wrk->app_event_queue = uword_to_pointer (mp->app_mq, svm_msg_q_t *);
61 ctrl_mq = uword_to_pointer (mp->vpp_ctrl_mq, svm_msg_q_t *);
62 vcm->ctrl_mq = wrk->ctrl_mq = ctrl_mq;
63 segment_handle = mp->segment_handle;
64 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
66 VERR ("invalid segment handle");
73 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
74 if (vcl_segment_attach (vcl_vpp_worker_segment_handle (0), "vpp-mq-seg",
75 SSVM_SEGMENT_MEMFD, fds[n_fds_used++]))
78 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
80 segment_name = format (0, "memfd-%ld%c", segment_handle, 0);
81 rv = vcl_segment_attach (segment_handle, (char *) segment_name,
82 SSVM_SEGMENT_MEMFD, fds[n_fds_used++]);
83 vec_free (segment_name);
88 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
90 svm_msg_q_set_consumer_eventfd (wrk->app_event_queue,
92 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
95 vcm->app_index = mp->app_index;
101 for (i = clib_max (n_fds_used - 1, 0); i < mp->n_fds; i++)
108 vcl_api_send_attach (clib_socket_t * cs)
110 app_sapi_msg_t msg = { 0 };
111 app_sapi_attach_msg_t *mp = &msg.attach;
112 u8 app_is_proxy, tls_engine;
115 app_is_proxy = (vcm->cfg.app_proxy_transport_tcp ||
116 vcm->cfg.app_proxy_transport_udp);
117 tls_engine = CRYPTO_ENGINE_OPENSSL;
119 clib_memcpy (&mp->name, vcm->app_name, vec_len (vcm->app_name));
120 mp->options[APP_OPTIONS_FLAGS] =
121 APP_OPTIONS_FLAGS_ACCEPT_REDIRECT | APP_OPTIONS_FLAGS_ADD_SEGMENT |
122 (vcm->cfg.app_scope_local ? APP_OPTIONS_FLAGS_USE_LOCAL_SCOPE : 0) |
123 (vcm->cfg.app_scope_global ? APP_OPTIONS_FLAGS_USE_GLOBAL_SCOPE : 0) |
124 (app_is_proxy ? APP_OPTIONS_FLAGS_IS_PROXY : 0) |
125 (vcm->cfg.use_mq_eventfd ? APP_OPTIONS_FLAGS_EVT_MQ_USE_EVENTFD : 0);
126 mp->options[APP_OPTIONS_PROXY_TRANSPORT] =
127 (u64) ((vcm->cfg.app_proxy_transport_tcp ? 1 << TRANSPORT_PROTO_TCP : 0) |
128 (vcm->cfg.app_proxy_transport_udp ? 1 << TRANSPORT_PROTO_UDP : 0));
129 mp->options[APP_OPTIONS_SEGMENT_SIZE] = vcm->cfg.segment_size;
130 mp->options[APP_OPTIONS_ADD_SEGMENT_SIZE] = vcm->cfg.add_segment_size;
131 mp->options[APP_OPTIONS_RX_FIFO_SIZE] = vcm->cfg.rx_fifo_size;
132 mp->options[APP_OPTIONS_TX_FIFO_SIZE] = vcm->cfg.tx_fifo_size;
133 mp->options[APP_OPTIONS_PREALLOC_FIFO_PAIRS] =
134 vcm->cfg.preallocated_fifo_pairs;
135 mp->options[APP_OPTIONS_EVT_QUEUE_SIZE] = vcm->cfg.event_queue_size;
136 mp->options[APP_OPTIONS_TLS_ENGINE] = tls_engine;
138 msg.type = APP_SAPI_MSG_TYPE_ATTACH;
139 err = clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
142 clib_error_report (err);
150 vcl_sapi_attach (void)
152 vcl_worker_t *wrk = vcl_worker_get_current ();
153 app_sapi_msg_t _rmp, *rmp = &_rmp;
156 int fds[SESSION_N_FD_TYPE];
159 * Init client socket and send attach
161 if (vcl_api_connect_app_socket (wrk))
164 cs = &wrk->app_api_sock;
165 if (vcl_api_send_attach (cs))
169 * Wait for attach reply
171 err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), fds, ARRAY_LEN (fds));
174 clib_error_report (err);
178 if (rmp->type != APP_SAPI_MSG_TYPE_ATTACH_REPLY)
181 return vcl_api_attach_reply_handler (&rmp->attach_reply, fds);
185 vcl_api_add_del_worker_reply_handler (app_sapi_worker_add_del_reply_msg_t *
188 int n_fds = 0, i, rv;
194 VDBG (0, "add/del worker failed: %U", format_session_error, mp->retval);
201 wrk = vcl_worker_get_current ();
202 wrk->api_client_handle = mp->api_client_handle;
203 wrk->vpp_wrk_index = mp->wrk_index;
204 wrk->app_event_queue = uword_to_pointer (mp->app_event_queue_address,
206 wrk->ctrl_mq = vcm->ctrl_mq;
208 segment_handle = mp->segment_handle;
209 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
211 clib_warning ("invalid segment handle");
218 if (mp->fd_flags & SESSION_FD_F_VPP_MQ_SEGMENT)
219 if (vcl_segment_attach (vcl_vpp_worker_segment_handle (wrk->wrk_index),
220 "vpp-worker-seg", SSVM_SEGMENT_MEMFD,
224 if (mp->fd_flags & SESSION_FD_F_MEMFD_SEGMENT)
226 u8 *segment_name = format (0, "memfd-%ld%c", segment_handle, 0);
227 rv = vcl_segment_attach (segment_handle, (char *) segment_name,
228 SSVM_SEGMENT_MEMFD, fds[n_fds++]);
229 vec_free (segment_name);
234 if (mp->fd_flags & SESSION_FD_F_MQ_EVENTFD)
236 svm_msg_q_set_consumer_eventfd (wrk->app_event_queue, fds[n_fds]);
237 vcl_mq_epoll_add_evfd (wrk, wrk->app_event_queue);
241 VDBG (0, "worker %u vpp-worker %u added", wrk->wrk_index,
247 for (i = clib_max (n_fds - 1, 0); i < mp->n_fds; i++)
254 vcl_sapi_app_worker_add (void)
256 vcl_worker_t *wrk = vcl_worker_get_current ();
257 app_sapi_worker_add_del_msg_t *mp;
258 app_sapi_msg_t _rmp, *rmp = &_rmp;
259 app_sapi_msg_t msg = { 0 };
260 int fds[SESSION_N_FD_TYPE];
264 /* Connect to socket api */
265 if (vcl_api_connect_app_socket (wrk))
271 cs = &wrk->app_api_sock;
273 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER;
274 mp = &msg.worker_add_del;
275 mp->app_index = vcm->app_index;
278 err = clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
281 clib_error_report (err);
286 * Wait for reply and process it
288 err = clib_socket_recvmsg (cs, rmp, sizeof (*rmp), fds, ARRAY_LEN (fds));
291 clib_error_report (err);
295 if (rmp->type != APP_SAPI_MSG_TYPE_ADD_DEL_WORKER_REPLY)
297 clib_warning ("unexpected reply type %u", rmp->type);
301 return vcl_api_add_del_worker_reply_handler (&rmp->worker_add_del_reply,
306 vcl_sapi_app_worker_del (vcl_worker_t * wrk)
308 app_sapi_worker_add_del_msg_t *mp;
309 app_sapi_msg_t msg = { 0 };
313 cs = &wrk->app_api_sock;
315 msg.type = APP_SAPI_MSG_TYPE_ADD_DEL_WORKER;
316 mp = &msg.worker_add_del;
317 mp->app_index = vcm->app_index;
318 mp->wrk_index = wrk->vpp_wrk_index;
321 err = clib_socket_sendmsg (cs, &msg, sizeof (msg), 0, 0);
323 clib_error_report (err);
324 clib_socket_close (cs);
328 vcl_sapi_detach (vcl_worker_t * wrk)
330 clib_socket_t *cs = &wrk->app_api_sock;
331 clib_socket_close (cs);
335 vcl_sapi_recv_fds (vcl_worker_t * wrk, int *fds, int n_fds)
337 app_sapi_msg_t _msg, *msg = &_msg;
341 cs = &wrk->app_api_sock;
343 err = clib_socket_recvmsg (cs, msg, sizeof (*msg), fds, n_fds);
346 clib_error_report (err);
349 if (msg->type != APP_SAPI_MSG_TYPE_SEND_FDS)
356 * fd.io coding-style-patch-verification: ON
359 * eval: (c-set-style "gnu")