2 * Copyright (c) 2017-2019 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.
18 #include <vcl/vppcom.h>
19 #include <vcl/vcl_debug.h>
20 #include <vcl/vcl_private.h>
21 #include <svm/fifo_segment.h>
23 __thread uword __vcl_worker_index = ~0;
26 vcl_mq_dequeue_batch (vcl_worker_t * wrk, svm_msg_q_t * mq, u32 n_max_msg)
28 u32 n_msgs = 0, sz, len;
30 while ((sz = svm_msg_q_size (mq)))
32 len = vec_len (wrk->mq_msg_vector);
33 vec_validate (wrk->mq_msg_vector, len + sz - 1);
34 svm_msg_q_sub_raw_batch (mq, wrk->mq_msg_vector + len, sz);
43 vcl_msg_add_ext_config (vcl_session_t *s, uword *offset)
47 c = vcl_segment_alloc_chunk (vcl_vpp_worker_segment_handle (0),
48 0 /* one slice only */, s->ext_config->len,
51 clib_memcpy_fast (c->data, s->ext_config, s->ext_config->len);
55 vcl_send_session_listen (vcl_worker_t * wrk, vcl_session_t * s)
57 app_session_evt_t _app_evt, *app_evt = &_app_evt;
58 session_listen_msg_t *mp;
61 mq = vcl_worker_ctrl_mq (wrk);
62 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_LISTEN);
63 mp = (session_listen_msg_t *) app_evt->evt->data;
64 memset (mp, 0, sizeof (*mp));
65 mp->client_index = wrk->api_client_handle;
66 mp->context = s->session_index;
67 mp->wrk_index = wrk->vpp_wrk_index;
68 mp->is_ip4 = s->transport.is_ip4;
69 clib_memcpy_fast (&mp->ip, &s->transport.lcl_ip, sizeof (mp->ip));
70 mp->port = s->transport.lcl_port;
71 mp->proto = s->session_type;
73 if (s->flags & VCL_SESSION_F_CONNECTED)
74 mp->flags = TRANSPORT_CFG_F_CONNECTED;
76 vcl_msg_add_ext_config (s, &mp->ext_config);
77 app_send_ctrl_evt_to_vpp (mq, app_evt);
80 clib_mem_free (s->ext_config);
86 vcl_send_session_connect (vcl_worker_t * wrk, vcl_session_t * s)
88 app_session_evt_t _app_evt, *app_evt = &_app_evt;
89 session_connect_msg_t *mp;
92 mq = vcl_worker_ctrl_mq (wrk);
93 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_CONNECT);
94 mp = (session_connect_msg_t *) app_evt->evt->data;
95 memset (mp, 0, sizeof (*mp));
96 mp->client_index = wrk->api_client_handle;
97 mp->context = s->session_index;
99 mp->wrk_index = wrk->vpp_wrk_index;
100 mp->is_ip4 = s->transport.is_ip4;
101 mp->parent_handle = s->parent_handle;
102 clib_memcpy_fast (&mp->ip, &s->transport.rmt_ip, sizeof (mp->ip));
103 clib_memcpy_fast (&mp->lcl_ip, &s->transport.lcl_ip, sizeof (mp->lcl_ip));
104 mp->port = s->transport.rmt_port;
105 mp->lcl_port = s->transport.lcl_port;
106 mp->proto = s->session_type;
108 if (s->flags & VCL_SESSION_F_CONNECTED)
109 mp->flags |= TRANSPORT_CFG_F_CONNECTED;
111 vcl_msg_add_ext_config (s, &mp->ext_config);
112 app_send_ctrl_evt_to_vpp (mq, app_evt);
116 clib_mem_free (s->ext_config);
122 vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s)
124 app_session_evt_t _app_evt, *app_evt = &_app_evt;
125 session_unlisten_msg_t *mp;
128 mq = vcl_worker_ctrl_mq (wrk);
129 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_UNLISTEN);
130 mp = (session_unlisten_msg_t *) app_evt->evt->data;
131 memset (mp, 0, sizeof (*mp));
132 mp->client_index = wrk->api_client_handle;
133 mp->wrk_index = wrk->vpp_wrk_index;
134 mp->handle = s->vpp_handle;
135 mp->context = wrk->wrk_index;
136 app_send_ctrl_evt_to_vpp (mq, app_evt);
140 vcl_send_session_shutdown (vcl_worker_t *wrk, vcl_session_t *s)
142 app_session_evt_t _app_evt, *app_evt = &_app_evt;
143 session_shutdown_msg_t *mp;
146 /* Send to thread that owns the session */
148 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_SHUTDOWN);
149 mp = (session_shutdown_msg_t *) app_evt->evt->data;
150 memset (mp, 0, sizeof (*mp));
151 mp->client_index = wrk->api_client_handle;
152 mp->handle = s->vpp_handle;
153 app_send_ctrl_evt_to_vpp (mq, app_evt);
157 vcl_send_session_disconnect (vcl_worker_t * wrk, vcl_session_t * s)
159 app_session_evt_t _app_evt, *app_evt = &_app_evt;
160 session_disconnect_msg_t *mp;
163 /* Send to thread that owns the session */
165 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_DISCONNECT);
166 mp = (session_disconnect_msg_t *) app_evt->evt->data;
167 memset (mp, 0, sizeof (*mp));
168 mp->client_index = wrk->api_client_handle;
169 mp->handle = s->vpp_handle;
170 app_send_ctrl_evt_to_vpp (mq, app_evt);
174 vcl_send_app_detach (vcl_worker_t * wrk)
176 app_session_evt_t _app_evt, *app_evt = &_app_evt;
177 session_app_detach_msg_t *mp;
180 mq = vcl_worker_ctrl_mq (wrk);
181 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_DETACH);
182 mp = (session_app_detach_msg_t *) app_evt->evt->data;
183 memset (mp, 0, sizeof (*mp));
184 mp->client_index = wrk->api_client_handle;
185 app_send_ctrl_evt_to_vpp (mq, app_evt);
189 vcl_send_session_accepted_reply (svm_msg_q_t * mq, u32 context,
190 session_handle_t handle, int retval)
192 app_session_evt_t _app_evt, *app_evt = &_app_evt;
193 session_accepted_reply_msg_t *rmp;
194 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_ACCEPTED_REPLY);
195 rmp = (session_accepted_reply_msg_t *) app_evt->evt->data;
196 rmp->handle = handle;
197 rmp->context = context;
198 rmp->retval = retval;
199 app_send_ctrl_evt_to_vpp (mq, app_evt);
203 vcl_send_session_disconnected_reply (vcl_worker_t * wrk, vcl_session_t * s,
206 app_session_evt_t _app_evt, *app_evt = &_app_evt;
207 session_disconnected_reply_msg_t *rmp;
208 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
209 SESSION_CTRL_EVT_DISCONNECTED_REPLY);
210 rmp = (session_disconnected_reply_msg_t *) app_evt->evt->data;
211 rmp->handle = s->vpp_handle;
212 rmp->context = wrk->api_client_handle;
213 rmp->retval = retval;
214 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
218 vcl_send_session_reset_reply (vcl_worker_t * wrk, vcl_session_t * s,
221 app_session_evt_t _app_evt, *app_evt = &_app_evt;
222 session_reset_reply_msg_t *rmp;
223 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
224 SESSION_CTRL_EVT_RESET_REPLY);
225 rmp = (session_reset_reply_msg_t *) app_evt->evt->data;
226 rmp->handle = s->vpp_handle;
227 rmp->context = wrk->api_client_handle;
228 rmp->retval = retval;
229 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
233 vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
236 app_session_evt_t _app_evt, *app_evt = &_app_evt;
237 session_worker_update_msg_t *mp;
239 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
240 SESSION_CTRL_EVT_WORKER_UPDATE);
241 mp = (session_worker_update_msg_t *) app_evt->evt->data;
242 mp->client_index = wrk->api_client_handle;
243 mp->handle = s->vpp_handle;
244 mp->req_wrk_index = wrk->vpp_wrk_index;
245 mp->wrk_index = wrk_index;
246 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
250 vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len)
252 app_session_evt_t _app_evt, *app_evt = &_app_evt;
253 session_app_wrk_rpc_msg_t *mp;
254 vcl_worker_t *dst_wrk, *wrk;
258 if (data_len > sizeof (mp->data))
261 clib_spinlock_lock (&vcm->workers_lock);
263 dst_wrk = vcl_worker_get_if_valid (dst_wrk_index);
267 wrk = vcl_worker_get_current ();
268 mq = vcl_worker_ctrl_mq (wrk);
269 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_WRK_RPC);
270 mp = (session_app_wrk_rpc_msg_t *) app_evt->evt->data;
271 mp->client_index = wrk->api_client_handle;
272 mp->wrk_index = dst_wrk->vpp_wrk_index;
273 clib_memcpy (mp->data, data, data_len);
274 app_send_ctrl_evt_to_vpp (mq, app_evt);
278 clib_spinlock_unlock (&vcm->workers_lock);
283 vcl_session_transport_attr (vcl_worker_t *wrk, vcl_session_t *s, u8 is_get,
284 transport_endpt_attr_t *attr)
286 app_session_evt_t _app_evt, *app_evt = &_app_evt;
287 session_transport_attr_msg_t *mp;
291 ASSERT (!wrk->session_attr_op);
292 wrk->session_attr_op = 1;
293 wrk->session_attr_op_rv = -1;
296 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_TRANSPORT_ATTR);
297 mp = (session_transport_attr_msg_t *) app_evt->evt->data;
298 memset (mp, 0, sizeof (*mp));
299 mp->client_index = wrk->api_client_handle;
300 mp->handle = s->vpp_handle;
303 app_send_ctrl_evt_to_vpp (mq, app_evt);
305 timeout = clib_time_now (&wrk->clib_time) + 1;
307 while (wrk->session_attr_op && clib_time_now (&wrk->clib_time) < timeout)
308 vcl_flush_mq_events ();
310 if (!wrk->session_attr_op_rv && is_get)
311 *attr = wrk->session_attr_rv;
313 wrk->session_attr_op = 0;
315 return wrk->session_attr_op_rv;
319 vcl_session_accepted_handler (vcl_worker_t * wrk, session_accepted_msg_t * mp,
322 vcl_session_t *session, *listen_session;
325 session = vcl_session_alloc (wrk);
327 listen_session = vcl_session_get (wrk, ls_index);
328 if (listen_session->vpp_handle != mp->listener_handle)
330 VDBG (0, "ERROR: listener handle %lu does not match session %u",
331 mp->listener_handle, ls_index);
335 if (vcl_segment_attach_session (
336 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
337 mp->vpp_event_queue_address, mp->mq_index, 0, session))
339 VDBG (0, "session %u [0x%llx]: failed to attach fifos",
340 session->session_index, mp->handle);
344 session->vpp_handle = mp->handle;
345 session->session_state = VCL_STATE_READY;
346 session->transport.rmt_port = mp->rmt.port;
347 session->transport.is_ip4 = mp->rmt.is_ip4;
348 clib_memcpy_fast (&session->transport.rmt_ip, &mp->rmt.ip,
349 sizeof (ip46_address_t));
351 vcl_session_table_add_vpp_handle (wrk, mp->handle, session->session_index);
352 session->transport.lcl_port = mp->lcl.port;
353 session->transport.lcl_ip = mp->lcl.ip;
354 session->session_type = listen_session->session_type;
355 session->is_dgram = vcl_proto_is_dgram (session->session_type);
356 session->listener_index = listen_session->session_index;
357 listen_session->n_accepted_sessions++;
359 vcl_evt (VCL_EVT_ACCEPT, session, listen_session, session_index);
361 vcl_send_session_accepted_reply (session->vpp_evt_q, mp->context,
362 session->vpp_handle, 0);
364 return session->session_index;
367 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0),
368 mp->vpp_event_queue_address, mp->mq_index, &evt_q);
369 vcl_send_session_accepted_reply (evt_q, mp->context, mp->handle,
370 VNET_API_ERROR_INVALID_ARGUMENT);
371 vcl_session_free (wrk, session);
372 return VCL_INVALID_SESSION_INDEX;
376 vcl_session_connected_handler (vcl_worker_t * wrk,
377 session_connected_msg_t * mp)
379 vcl_session_t *session = 0;
382 session_index = mp->context;
383 session = vcl_session_get (wrk, session_index);
384 if (PREDICT_FALSE (!session))
386 VERR ("vpp handle 0x%llx has no session index (%u)!", mp->handle,
388 /* Should not happen but if it does, force vpp session cleanup */
389 vcl_session_t tmp_session = {
390 .vpp_handle = mp->handle,
393 vcl_segment_attach_session (
394 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
395 mp->vpp_event_queue_address, mp->mq_index, 0, session);
396 if (tmp_session.vpp_evt_q)
397 vcl_send_session_disconnect (wrk, &tmp_session);
398 return VCL_INVALID_SESSION_INDEX;
403 VDBG (0, "session %u: connect failed! %U", session_index,
404 format_session_error, mp->retval);
405 session->session_state = VCL_STATE_DETACHED;
406 session->vpp_handle = VCL_INVALID_SESSION_HANDLE;
407 return session_index;
410 session->vpp_handle = mp->handle;
412 /* Add to lookup table. Even if something fails, session cannot be
413 * cleaned up prior to notifying vpp and going through the cleanup
414 * "procedure" see @ref vcl_session_cleanup_handler */
415 vcl_session_table_add_vpp_handle (wrk, mp->handle, session_index);
417 if (vcl_segment_attach_session (
418 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
419 mp->vpp_event_queue_address, mp->mq_index, 0, session))
421 VDBG (0, "session %u [0x%llx]: failed to attach fifos",
422 session->session_index, session->vpp_handle);
423 session->session_state = VCL_STATE_UPDATED;
424 vcl_send_session_disconnect (wrk, session);
425 return session_index;
430 if (vcl_segment_attach_session (mp->ct_segment_handle, mp->ct_rx_fifo,
431 mp->ct_tx_fifo, (uword) ~0, ~0, 1,
434 VDBG (0, "session %u [0x%llx]: failed to attach ct fifos",
435 session->session_index, session->vpp_handle);
436 session->session_state = VCL_STATE_UPDATED;
437 vcl_send_session_disconnect (wrk, session);
438 return session_index;
442 session->transport.is_ip4 = mp->lcl.is_ip4;
443 clib_memcpy_fast (&session->transport.lcl_ip, &mp->lcl.ip,
444 sizeof (session->transport.lcl_ip));
445 session->transport.lcl_port = mp->lcl.port;
447 /* Application closed session before connect reply */
448 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK)
449 && session->session_state == VCL_STATE_CLOSED)
450 vcl_send_session_disconnect (wrk, session);
452 session->session_state = VCL_STATE_READY;
454 VDBG (0, "session %u [0x%llx] connected local: %U:%u remote %U:%u",
455 session->session_index, session->vpp_handle, vcl_format_ip46_address,
456 &session->transport.lcl_ip,
457 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
458 clib_net_to_host_u16 (session->transport.lcl_port),
459 vcl_format_ip46_address, &session->transport.rmt_ip,
460 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
461 clib_net_to_host_u16 (session->transport.rmt_port));
463 return session_index;
467 vcl_flag_accepted_session (vcl_session_t * session, u64 handle, u32 flags)
469 vcl_session_msg_t *accepted_msg;
472 for (i = 0; i < vec_len (session->accept_evts_fifo); i++)
474 accepted_msg = &session->accept_evts_fifo[i];
475 if (accepted_msg->accepted_msg.handle == handle)
477 accepted_msg->flags |= flags;
485 vcl_session_reset_handler (vcl_worker_t * wrk,
486 session_reset_msg_t * reset_msg)
488 vcl_session_t *session;
491 sid = vcl_session_index_from_vpp_handle (wrk, reset_msg->handle);
492 session = vcl_session_get (wrk, sid);
495 VDBG (0, "request to reset unknown handle 0x%llx", reset_msg->handle);
496 return VCL_INVALID_SESSION_INDEX;
499 /* Caught a reset before actually accepting the session */
500 if (session->session_state == VCL_STATE_LISTEN)
503 if (!vcl_flag_accepted_session (session, reset_msg->handle,
504 VCL_ACCEPTED_F_RESET))
505 VDBG (0, "session was not accepted!");
506 return VCL_INVALID_SESSION_INDEX;
509 if (session->session_state != VCL_STATE_CLOSED)
510 session->session_state = VCL_STATE_DISCONNECT;
511 VDBG (0, "session %u [0x%llx]: reset", sid, reset_msg->handle);
516 vcl_session_bound_handler (vcl_worker_t * wrk, session_bound_msg_t * mp)
518 vcl_session_t *session;
519 u32 sid = mp->context;
521 session = vcl_session_get (wrk, sid);
524 VERR ("session %u [0x%llx]: bind failed: %U", sid, mp->handle,
525 format_session_error, mp->retval);
528 session->session_state = VCL_STATE_DETACHED;
529 session->vpp_handle = mp->handle;
534 VDBG (0, "session %u [0x%llx]: Invalid session index!", sid,
536 return VCL_INVALID_SESSION_INDEX;
540 session->vpp_handle = mp->handle;
541 session->transport.is_ip4 = mp->lcl_is_ip4;
542 clib_memcpy_fast (&session->transport.lcl_ip, mp->lcl_ip,
543 sizeof (ip46_address_t));
544 session->transport.lcl_port = mp->lcl_port;
545 vcl_session_table_add_listener (wrk, mp->handle, sid);
546 session->session_state = VCL_STATE_LISTEN;
548 if (vcl_session_is_cl (session))
550 if (vcl_segment_attach_session (mp->segment_handle, mp->rx_fifo,
551 mp->tx_fifo, mp->vpp_evt_q, mp->mq_index,
554 VDBG (0, "session %u [0x%llx]: failed to attach fifos",
555 session->session_index, session->vpp_handle);
556 session->session_state = VCL_STATE_DETACHED;
557 return VCL_INVALID_SESSION_INDEX;
561 VDBG (0, "session %u [0x%llx]: listen succeeded!", sid, mp->handle);
566 vcl_session_unlisten_reply_handler (vcl_worker_t * wrk, void *data)
568 session_unlisten_reply_msg_t *mp = (session_unlisten_reply_msg_t *) data;
571 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
574 VDBG (0, "Unlisten reply with wrong handle %llx", mp->handle);
577 if (s->session_state != VCL_STATE_DISCONNECT)
579 /* Connected udp listener */
580 if (s->session_type == VPPCOM_PROTO_UDP
581 && s->session_state == VCL_STATE_CLOSED)
584 VDBG (0, "Unlisten session in wrong state %llx", mp->handle);
589 VDBG (0, "ERROR: session %u [0xllx]: unlisten failed: %U",
590 s->session_index, mp->handle, format_session_error, mp->retval);
592 if (mp->context != wrk->wrk_index)
593 VDBG (0, "wrong context");
595 vcl_session_table_del_vpp_handle (wrk, mp->handle);
596 vcl_session_free (wrk, s);
600 vcl_session_migrated_handler (vcl_worker_t * wrk, void *data)
602 session_migrated_msg_t *mp = (session_migrated_msg_t *) data;
606 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
609 VDBG (0, "Migrated notification with wrong handle %llx", mp->handle);
613 /* Only validate if a value is provided */
614 if (mp->segment_handle != SESSION_INVALID_HANDLE)
616 fs_index = vcl_segment_table_lookup (mp->segment_handle);
617 if (fs_index == VCL_INVALID_SEGMENT_INDEX)
619 VDBG (0, "segment %lx for session %u is not mounted!",
620 mp->segment_handle, s->session_index);
621 s->session_state = VCL_STATE_DETACHED;
626 s->vpp_handle = mp->new_handle;
628 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0), mp->vpp_evt_q,
629 mp->vpp_thread_index, &s->vpp_evt_q);
631 vcl_session_table_del_vpp_handle (wrk, mp->handle);
632 vcl_session_table_add_vpp_handle (wrk, mp->new_handle, s->session_index);
634 /* Generate new tx event if we have outstanding data */
635 if (svm_fifo_has_event (s->tx_fifo))
636 app_send_io_evt_to_vpp (s->vpp_evt_q,
637 s->tx_fifo->shr->master_session_index,
638 SESSION_IO_EVT_TX, SVM_Q_WAIT);
640 VDBG (0, "Migrated 0x%lx to thread %u 0x%lx", mp->handle,
641 mp->vpp_thread_index, mp->new_handle);
644 static vcl_session_t *
645 vcl_session_accepted (vcl_worker_t * wrk, session_accepted_msg_t * msg)
647 vcl_session_msg_t *vcl_msg;
648 vcl_session_t *session;
650 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
651 if (PREDICT_FALSE (session != 0))
652 VWRN ("session overlap handle %lu state %u!", msg->handle,
653 session->session_state);
655 session = vcl_session_table_lookup_listener (wrk, msg->listener_handle);
658 VERR ("couldn't find listen session: listener handle %llx",
659 msg->listener_handle);
663 clib_fifo_add2 (session->accept_evts_fifo, vcl_msg);
665 vcl_msg->accepted_msg = *msg;
666 /* Session handle points to listener until fully accepted by app */
667 vcl_session_table_add_vpp_handle (wrk, msg->handle, session->session_index);
672 static vcl_session_t *
673 vcl_session_disconnected_handler (vcl_worker_t * wrk,
674 session_disconnected_msg_t * msg)
676 vcl_session_t *session;
678 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
681 VWRN ("request to disconnect unknown handle 0x%llx", msg->handle);
685 /* Late disconnect notification on a session that has been closed */
686 if (session->session_state == VCL_STATE_CLOSED)
689 /* Caught a disconnect before actually accepting the session */
690 if (session->session_state == VCL_STATE_LISTEN)
692 if (!vcl_flag_accepted_session (session, msg->handle,
693 VCL_ACCEPTED_F_CLOSED))
694 VDBG (0, "session was not accepted!");
698 /* If not already reset change state */
699 if (session->session_state != VCL_STATE_DISCONNECT)
700 session->session_state = VCL_STATE_VPP_CLOSING;
706 vppcom_session_shutdown (uint32_t session_handle, int how)
708 vcl_worker_t *wrk = vcl_worker_get_current ();
709 vcl_session_t *session;
710 vcl_session_state_t state;
713 session = vcl_session_get_w_handle (wrk, session_handle);
714 if (PREDICT_FALSE (!session))
715 return VPPCOM_EBADFD;
717 vpp_handle = session->vpp_handle;
718 state = session->session_state;
720 VDBG (1, "session %u [0x%llx] state 0x%x (%s)", session->session_index,
721 vpp_handle, state, vcl_session_state_str (state));
723 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
725 VDBG (0, "ERROR: Cannot shutdown a listen socket!");
726 return VPPCOM_EBADFD;
729 if (how == SHUT_RD || how == SHUT_RDWR)
731 session->flags |= VCL_SESSION_F_RD_SHUTDOWN;
735 session->flags |= VCL_SESSION_F_WR_SHUTDOWN;
737 if (PREDICT_TRUE (state == VCL_STATE_READY))
739 VDBG (1, "session %u [0x%llx]: sending shutdown...",
740 session->session_index, vpp_handle);
742 vcl_send_session_shutdown (wrk, session);
749 vppcom_session_disconnect (u32 session_handle)
751 vcl_worker_t *wrk = vcl_worker_get_current ();
752 vcl_session_t *session, *listen_session;
753 vcl_session_state_t state;
756 session = vcl_session_get_w_handle (wrk, session_handle);
758 return VPPCOM_EBADFD;
760 vpp_handle = session->vpp_handle;
761 state = session->session_state;
763 VDBG (1, "session %u [0x%llx]: disconnecting state (%s)",
764 session->session_index, vpp_handle, vcl_session_state_str (state));
766 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
768 VDBG (0, "ERROR: Cannot disconnect a listen socket!");
769 return VPPCOM_EBADFD;
772 if (state == VCL_STATE_VPP_CLOSING)
774 vcl_send_session_disconnected_reply (wrk, session, 0);
775 VDBG (1, "session %u [0x%llx]: sending disconnect REPLY...",
776 session->session_index, vpp_handle);
780 /* Session doesn't have an event queue yet. Probably a non-blocking
781 * connect. Wait for the reply */
782 if (PREDICT_FALSE (!session->vpp_evt_q))
785 VDBG (1, "session %u [0x%llx]: sending disconnect",
786 session->session_index, vpp_handle);
787 vcl_send_session_disconnect (wrk, session);
790 if (session->listener_index != VCL_INVALID_SESSION_INDEX)
792 listen_session = vcl_session_get (wrk, session->listener_index);
793 listen_session->n_accepted_sessions--;
800 vcl_session_cleanup_handler (vcl_worker_t * wrk, void *data)
802 session_cleanup_msg_t *msg;
803 vcl_session_t *session;
805 msg = (session_cleanup_msg_t *) data;
806 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
809 VWRN ("disconnect confirmed for unknown handle 0x%llx", msg->handle);
813 if (msg->type == SESSION_CLEANUP_TRANSPORT)
815 /* Transport was cleaned up before we confirmed close. Probably the
816 * app is still waiting for some data that cannot be delivered.
817 * Confirm close to make sure everything is cleaned up.
818 * Move to undetermined state to ensure that the session is not
819 * removed before both vpp and the app cleanup.
820 * - If the app closes first, the session is moved to CLOSED state
821 * and the session cleanup notification from vpp removes the
823 * - If vpp cleans up the session first, the session is moved to
824 * DETACHED state lower and subsequently the close from the app
827 if (session->session_state == VCL_STATE_VPP_CLOSING)
829 vppcom_session_disconnect (vcl_session_handle (session));
830 session->session_state = VCL_STATE_UPDATED;
832 else if (session->session_state == VCL_STATE_DISCONNECT)
834 vcl_send_session_reset_reply (wrk, session, 0);
835 session->session_state = VCL_STATE_UPDATED;
840 /* VPP will reuse the handle so clean it up now */
841 vcl_session_table_del_vpp_handle (wrk, msg->handle);
843 /* App did not close the connection yet so don't free it. */
844 if (session->session_state != VCL_STATE_CLOSED)
846 VDBG (0, "session %u: app did not close", session->session_index);
847 session->session_state = VCL_STATE_DETACHED;
848 session->vpp_handle = VCL_INVALID_SESSION_HANDLE;
852 /* Session probably tracked with epoll, disconnect not yet handled and
853 * 1) both transport and session cleanup completed 2) app closed. Wait
854 * until message is drained to free the session.
855 * See @ref vcl_handle_mq_event */
856 if (session->flags & VCL_SESSION_F_PENDING_DISCONNECT)
858 session->flags |= VCL_SESSION_F_PENDING_FREE;
862 vcl_session_free (wrk, session);
866 vcl_session_req_worker_update_handler (vcl_worker_t * wrk, void *data)
868 session_req_worker_update_msg_t *msg;
871 msg = (session_req_worker_update_msg_t *) data;
872 s = vcl_session_get_w_vpp_handle (wrk, msg->session_handle);
876 vec_add1 (wrk->pending_session_wrk_updates, s->session_index);
880 vcl_session_worker_update_reply_handler (vcl_worker_t * wrk, void *data)
882 session_worker_update_reply_msg_t *msg;
885 msg = (session_worker_update_reply_msg_t *) data;
886 s = vcl_session_get_w_vpp_handle (wrk, msg->handle);
889 VDBG (0, "unknown handle 0x%llx", msg->handle);
895 if (vcl_segment_attach_session (msg->segment_handle, msg->rx_fifo,
896 msg->tx_fifo, (uword) ~0, ~0, 0, s))
898 VDBG (0, "failed to attach fifos for %u", s->session_index);
902 s->session_state = VCL_STATE_UPDATED;
904 VDBG (0, "session %u[0x%llx] moved to worker %u", s->session_index,
905 s->vpp_handle, wrk->wrk_index);
909 vcl_api_recv_fd (vcl_worker_t * wrk, int *fds, int n_fds)
912 if (vcm->cfg.vpp_app_socket_api)
913 return vcl_sapi_recv_fds (wrk, fds, n_fds);
915 return vcl_bapi_recv_fds (wrk, fds, n_fds);
919 vcl_session_app_add_segment_handler (vcl_worker_t * wrk, void *data)
921 ssvm_segment_type_t seg_type = SSVM_SEGMENT_SHM;
922 session_app_add_segment_msg_t *msg;
926 msg = (session_app_add_segment_msg_t *) data;
930 vcl_api_recv_fd (wrk, &fd, 1);
931 seg_type = SSVM_SEGMENT_MEMFD;
934 segment_handle = msg->segment_handle;
935 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
937 clib_warning ("invalid segment handle");
941 if (vcl_segment_attach (segment_handle, (char *) msg->segment_name,
944 VDBG (0, "vcl_segment_attach ('%s') failed", msg->segment_name);
948 VDBG (1, "mapped new segment '%s' size %d", msg->segment_name,
953 vcl_session_app_del_segment_handler (vcl_worker_t * wrk, void *data)
955 session_app_del_segment_msg_t *msg = (session_app_del_segment_msg_t *) data;
956 vcl_segment_detach (msg->segment_handle);
957 VDBG (1, "Unmapped segment: %d", msg->segment_handle);
961 vcl_worker_rpc_handler (vcl_worker_t * wrk, void *data)
963 if (!vcm->wrk_rpc_fn)
966 (vcm->wrk_rpc_fn) (((session_app_wrk_rpc_msg_t *) data)->data);
970 vcl_session_transport_attr_reply_handler (vcl_worker_t *wrk, void *data)
972 session_transport_attr_reply_msg_t *mp;
974 if (!wrk->session_attr_op)
977 mp = (session_transport_attr_reply_msg_t *) data;
979 wrk->session_attr_op_rv = mp->retval;
980 wrk->session_attr_op = 0;
981 wrk->session_attr_rv = mp->attr;
985 vcl_handle_mq_event (vcl_worker_t * wrk, session_event_t * e)
987 session_disconnected_msg_t *disconnected_msg;
988 session_connected_msg_t *connected_msg;
989 session_reset_msg_t *reset_msg;
990 session_event_t *ecpy;
994 switch (e->event_type)
996 case SESSION_IO_EVT_RX:
997 case SESSION_IO_EVT_TX:
998 s = vcl_session_get (wrk, e->session_index);
999 if (!s || !vcl_session_is_open (s))
1001 vec_add1 (wrk->unhandled_evts_vector, *e);
1003 case SESSION_CTRL_EVT_BOUND:
1004 /* We can only wait for only one listen so not postponed */
1005 vcl_session_bound_handler (wrk, (session_bound_msg_t *) e->data);
1007 case SESSION_CTRL_EVT_ACCEPTED:
1008 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
1009 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1011 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1013 ecpy->postponed = 1;
1014 ecpy->session_index = s->session_index;
1017 case SESSION_CTRL_EVT_CONNECTED:
1018 connected_msg = (session_connected_msg_t *) e->data;
1019 sid = vcl_session_connected_handler (wrk, connected_msg);
1020 if (!(s = vcl_session_get (wrk, sid)))
1022 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1024 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1026 ecpy->postponed = 1;
1027 ecpy->session_index = s->session_index;
1030 case SESSION_CTRL_EVT_DISCONNECTED:
1031 disconnected_msg = (session_disconnected_msg_t *) e->data;
1032 if (!(s = vcl_session_get_w_vpp_handle (wrk, disconnected_msg->handle)))
1034 if (s->session_state == VCL_STATE_CLOSED)
1036 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1038 s->session_state = VCL_STATE_VPP_CLOSING;
1039 s->flags |= VCL_SESSION_F_PENDING_DISCONNECT;
1040 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1042 ecpy->postponed = 1;
1043 ecpy->session_index = s->session_index;
1046 if (!(s = vcl_session_disconnected_handler (wrk, disconnected_msg)))
1048 VDBG (0, "disconnected session %u [0x%llx]", s->session_index,
1051 case SESSION_CTRL_EVT_RESET:
1052 reset_msg = (session_reset_msg_t *) e->data;
1053 if (!(s = vcl_session_get_w_vpp_handle (wrk, reset_msg->handle)))
1055 if (s->session_state == VCL_STATE_CLOSED)
1057 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1059 s->flags |= VCL_SESSION_F_PENDING_DISCONNECT;
1060 s->session_state = VCL_STATE_DISCONNECT;
1061 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1063 ecpy->postponed = 1;
1064 ecpy->session_index = s->session_index;
1067 vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
1069 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
1070 vcl_session_unlisten_reply_handler (wrk, e->data);
1072 case SESSION_CTRL_EVT_MIGRATED:
1073 vcl_session_migrated_handler (wrk, e->data);
1075 case SESSION_CTRL_EVT_CLEANUP:
1076 vcl_session_cleanup_handler (wrk, e->data);
1078 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
1079 vcl_session_req_worker_update_handler (wrk, e->data);
1081 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
1082 vcl_session_worker_update_reply_handler (wrk, e->data);
1084 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
1085 vcl_session_app_add_segment_handler (wrk, e->data);
1087 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
1088 vcl_session_app_del_segment_handler (wrk, e->data);
1090 case SESSION_CTRL_EVT_APP_WRK_RPC:
1091 vcl_worker_rpc_handler (wrk, e->data);
1093 case SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY:
1094 vcl_session_transport_attr_reply_handler (wrk, e->data);
1097 clib_warning ("unhandled %u", e->event_type);
1103 vppcom_wait_for_session_state_change (u32 session_index,
1104 vcl_session_state_t state,
1107 vcl_worker_t *wrk = vcl_worker_get_current ();
1108 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
1109 vcl_session_t *volatile session;
1110 svm_msg_q_msg_t msg;
1115 session = vcl_session_get (wrk, session_index);
1116 if (PREDICT_FALSE (!session))
1118 return VPPCOM_EBADFD;
1120 if (session->session_state == state)
1124 if (session->session_state == VCL_STATE_DETACHED)
1126 return VPPCOM_ECONNREFUSED;
1129 if (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0))
1134 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
1135 vcl_handle_mq_event (wrk, e);
1136 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
1138 while (clib_time_now (&wrk->clib_time) < timeout);
1140 VDBG (0, "timeout waiting for state 0x%x (%s)", state,
1141 vcl_session_state_str (state));
1142 vcl_evt (VCL_EVT_SESSION_TIMEOUT, session, session_state);
1144 return VPPCOM_ETIMEDOUT;
1148 vcl_handle_pending_wrk_updates (vcl_worker_t * wrk)
1150 vcl_session_state_t state;
1154 if (PREDICT_TRUE (vec_len (wrk->pending_session_wrk_updates) == 0))
1157 vec_foreach (sip, wrk->pending_session_wrk_updates)
1159 s = vcl_session_get (wrk, *sip);
1160 vcl_send_session_worker_update (wrk, s, wrk->wrk_index);
1161 state = s->session_state;
1162 vppcom_wait_for_session_state_change (s->session_index, VCL_STATE_UPDATED,
1164 s->session_state = state;
1166 vec_reset_length (wrk->pending_session_wrk_updates);
1170 vcl_worker_flush_mq_events (vcl_worker_t *wrk)
1172 svm_msg_q_msg_t *msg;
1177 mq = wrk->app_event_queue;
1178 vcl_mq_dequeue_batch (wrk, mq, ~0);
1180 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
1182 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
1183 e = svm_msg_q_msg_data (mq, msg);
1184 vcl_handle_mq_event (wrk, e);
1185 svm_msg_q_free_msg (mq, msg);
1187 vec_reset_length (wrk->mq_msg_vector);
1188 vcl_handle_pending_wrk_updates (wrk);
1192 vcl_flush_mq_events (void)
1194 vcl_worker_flush_mq_events (vcl_worker_get_current ());
1198 vppcom_session_unbind (u32 session_handle)
1200 vcl_worker_t *wrk = vcl_worker_get_current ();
1201 session_accepted_msg_t *accepted_msg;
1202 vcl_session_t *session = 0;
1203 vcl_session_msg_t *evt;
1205 session = vcl_session_get_w_handle (wrk, session_handle);
1207 return VPPCOM_EBADFD;
1209 /* Flush pending accept events, if any */
1210 while (clib_fifo_elts (session->accept_evts_fifo))
1212 clib_fifo_sub2 (session->accept_evts_fifo, evt);
1213 accepted_msg = &evt->accepted_msg;
1214 vcl_session_table_del_vpp_handle (wrk, accepted_msg->handle);
1215 vcl_send_session_accepted_reply (session->vpp_evt_q,
1216 accepted_msg->context,
1217 accepted_msg->handle, -1);
1219 clib_fifo_free (session->accept_evts_fifo);
1221 vcl_send_session_unlisten (wrk, session);
1223 VDBG (1, "session %u [0x%llx]: sending unbind!", session->session_index,
1224 session->vpp_handle);
1225 vcl_evt (VCL_EVT_UNBIND, session);
1227 session->vpp_handle = ~0;
1228 session->session_state = VCL_STATE_DISCONNECT;
1236 * Notify vpp of the disconnect and mark the worker as free. If we're the
1237 * last worker, do a full cleanup otherwise, since we're probably a forked
1238 * child, avoid syscalls as much as possible. We might've lost privileges.
1241 vppcom_app_exit (void)
1243 if (!pool_elts (vcm->workers))
1245 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
1246 vcl_set_worker_index (~0);
1247 vcl_elog_stop (vcm);
1251 vcl_api_attach (void)
1253 if (vcm->cfg.vpp_app_socket_api)
1254 return vcl_sapi_attach ();
1256 return vcl_bapi_attach ();
1260 vcl_api_detach (vcl_worker_t * wrk)
1262 vcl_send_app_detach (wrk);
1264 if (vcm->cfg.vpp_app_socket_api)
1265 return vcl_sapi_detach (wrk);
1267 return vcl_bapi_disconnect_from_vpp ();
1271 * VPPCOM Public API functions
1274 vppcom_app_create (const char *app_name)
1276 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1281 VDBG (1, "already initialized");
1282 return VPPCOM_EEXIST;
1286 vppcom_cfg (&vcm->cfg);
1287 vcl_cfg = &vcm->cfg;
1289 vcm->main_cpu = pthread_self ();
1290 vcm->main_pid = getpid ();
1291 vcm->app_name = format (0, "%s", app_name);
1292 fifo_segment_main_init (&vcm->segment_main, (uword) ~0,
1293 20 /* timeout in secs */);
1294 pool_alloc (vcm->workers, vcl_cfg->max_workers);
1295 clib_spinlock_init (&vcm->workers_lock);
1296 clib_rwlock_init (&vcm->segment_table_lock);
1297 atexit (vppcom_app_exit);
1298 vcl_elog_init (vcm);
1300 /* Allocate default worker */
1301 vcl_worker_alloc_and_init ();
1303 if ((rv = vcl_api_attach ()))
1306 VDBG (0, "app_name '%s', my_client_index %d (0x%x)", app_name,
1307 vcm->workers[0].api_client_handle, vcm->workers[0].api_client_handle);
1313 vppcom_app_destroy (void)
1315 vcl_worker_t *wrk, *current_wrk;
1318 if (!pool_elts (vcm->workers))
1321 vcl_evt (VCL_EVT_DETACH, vcm);
1323 current_wrk = vcl_worker_get_current ();
1326 pool_foreach (wrk, vcm->workers) {
1327 if (current_wrk != wrk)
1328 vcl_worker_cleanup (wrk, 0 /* notify vpp */ );
1332 vcl_api_detach (current_wrk);
1333 vcl_worker_cleanup (current_wrk, 0 /* notify vpp */ );
1335 vcl_elog_stop (vcm);
1338 * Free the heap and fix vcm
1340 heap = clib_mem_get_heap ();
1341 munmap (clib_mem_get_heap_base (heap), clib_mem_get_heap_size (heap));
1343 vcm = &_vppcom_main;
1348 vppcom_session_create (u8 proto, u8 is_nonblocking)
1350 vcl_worker_t *wrk = vcl_worker_get_current ();
1351 vcl_session_t *session;
1353 session = vcl_session_alloc (wrk);
1355 session->session_type = proto;
1356 session->session_state = VCL_STATE_CLOSED;
1357 session->vpp_handle = ~0;
1358 session->is_dgram = vcl_proto_is_dgram (proto);
1361 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
1363 vcl_evt (VCL_EVT_CREATE, session, session_type, session->session_state,
1364 is_nonblocking, session_index);
1366 VDBG (0, "created session %u", session->session_index);
1368 return vcl_session_handle (session);
1372 vcl_epoll_lt_add (vcl_worker_t *wrk, vcl_session_t *s)
1374 vcl_session_t *cur, *prev;
1376 if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX)
1378 wrk->ep_lt_current = s->session_index;
1379 s->vep.lt_next = s->session_index;
1380 s->vep.lt_prev = s->session_index;
1384 cur = vcl_session_get (wrk, wrk->ep_lt_current);
1385 prev = vcl_session_get (wrk, cur->vep.lt_prev);
1387 prev->vep.lt_next = s->session_index;
1388 s->vep.lt_prev = prev->session_index;
1390 s->vep.lt_next = cur->session_index;
1391 cur->vep.lt_prev = s->session_index;
1395 vcl_epoll_lt_del (vcl_worker_t *wrk, vcl_session_t *s)
1397 vcl_session_t *prev, *next;
1399 if (s->vep.lt_next == s->session_index)
1401 wrk->ep_lt_current = VCL_INVALID_SESSION_INDEX;
1402 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
1406 prev = vcl_session_get (wrk, s->vep.lt_prev);
1407 next = vcl_session_get (wrk, s->vep.lt_next);
1409 prev->vep.lt_next = next->session_index;
1410 next->vep.lt_prev = prev->session_index;
1412 if (s->session_index == wrk->ep_lt_current)
1413 wrk->ep_lt_current = s->vep.lt_next;
1415 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
1419 vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * s,
1420 vcl_session_handle_t sh, u8 do_disconnect)
1424 VDBG (1, "session %u [0x%llx] closing", s->session_index, s->vpp_handle);
1426 if (s->flags & VCL_SESSION_F_IS_VEP)
1428 u32 next_sh = s->vep.next_sh;
1429 while (next_sh != ~0)
1431 rv = vppcom_epoll_ctl (sh, EPOLL_CTL_DEL, next_sh, 0);
1432 if (PREDICT_FALSE (rv < 0))
1433 VDBG (0, "vpp handle 0x%llx, sh %u: EPOLL_CTL_DEL vep_idx %u"
1434 " failed! rv %d (%s)", s->vpp_handle, next_sh,
1435 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1436 next_sh = s->vep.next_sh;
1441 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
1443 rv = vppcom_epoll_ctl (s->vep.vep_sh, EPOLL_CTL_DEL, sh, 0);
1445 VDBG (0, "session %u [0x%llx]: EPOLL_CTL_DEL vep_idx %u "
1446 "failed! rv %d (%s)", s->session_index, s->vpp_handle,
1447 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1452 VDBG (1, "session %u [0x%llx] disconnect skipped",
1453 s->session_index, s->vpp_handle);
1457 if (s->session_state == VCL_STATE_LISTEN)
1459 rv = vppcom_session_unbind (sh);
1460 if (PREDICT_FALSE (rv < 0))
1461 VDBG (0, "session %u [0x%llx]: listener unbind failed! "
1462 "rv %d (%s)", s->session_index, s->vpp_handle, rv,
1463 vppcom_retval_str (rv));
1466 else if (vcl_session_is_ready (s)
1467 || (vcl_session_is_connectable_listener (wrk, s)))
1469 rv = vppcom_session_disconnect (sh);
1470 if (PREDICT_FALSE (rv < 0))
1471 VDBG (0, "ERROR: session %u [0x%llx]: disconnect failed!"
1472 " rv %d (%s)", s->session_index, s->vpp_handle,
1473 rv, vppcom_retval_str (rv));
1475 else if (s->session_state == VCL_STATE_DISCONNECT)
1477 vcl_send_session_reset_reply (wrk, s, 0);
1479 else if (s->session_state == VCL_STATE_DETACHED)
1481 VDBG (0, "vpp freed session %d before close", s->session_index);
1483 if (!(s->flags & VCL_SESSION_F_PENDING_DISCONNECT))
1486 /* Disconnect/reset messages pending but vpp transport and session
1487 * cleanups already done. Free only after messages drained. */
1488 s->flags |= VCL_SESSION_F_PENDING_FREE;
1491 s->session_state = VCL_STATE_CLOSED;
1493 /* Session is removed only after vpp confirms the disconnect */
1497 vcl_session_table_del_vpp_handle (wrk, s->vpp_handle);
1499 vcl_session_free (wrk, s);
1500 vcl_evt (VCL_EVT_CLOSE, s, rv);
1506 vppcom_session_close (uint32_t session_handle)
1508 vcl_worker_t *wrk = vcl_worker_get_current ();
1509 vcl_session_t *session;
1511 session = vcl_session_get_w_handle (wrk, session_handle);
1513 return VPPCOM_EBADFD;
1514 return vcl_session_cleanup (wrk, session, session_handle,
1515 1 /* do_disconnect */ );
1519 vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep)
1521 vcl_worker_t *wrk = vcl_worker_get_current ();
1522 vcl_session_t *session = 0;
1525 return VPPCOM_EINVAL;
1527 session = vcl_session_get_w_handle (wrk, session_handle);
1529 return VPPCOM_EBADFD;
1531 if (session->flags & VCL_SESSION_F_IS_VEP)
1533 VDBG (0, "ERROR: cannot bind to epoll session %u!",
1534 session->session_index);
1535 return VPPCOM_EBADFD;
1538 session->transport.is_ip4 = ep->is_ip4;
1540 clib_memcpy_fast (&session->transport.lcl_ip.ip4, ep->ip,
1541 sizeof (ip4_address_t));
1543 clib_memcpy_fast (&session->transport.lcl_ip.ip6, ep->ip,
1544 sizeof (ip6_address_t));
1545 session->transport.lcl_port = ep->port;
1548 "session %u handle %u: binding to local %s address %U port %u, "
1550 session->session_index, session_handle,
1551 session->transport.is_ip4 ? "IPv4" : "IPv6", vcl_format_ip46_address,
1552 &session->transport.lcl_ip,
1553 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1554 clib_net_to_host_u16 (session->transport.lcl_port),
1555 vppcom_proto_str (session->session_type));
1556 vcl_evt (VCL_EVT_BIND, session);
1558 if (session->session_type == VPPCOM_PROTO_UDP)
1559 vppcom_session_listen (session_handle, 10);
1565 vppcom_session_listen (uint32_t listen_sh, uint32_t q_len)
1567 vcl_worker_t *wrk = vcl_worker_get_current ();
1568 vcl_session_t *listen_session = 0;
1569 u64 listen_vpp_handle;
1572 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1573 if (!listen_session || (listen_session->flags & VCL_SESSION_F_IS_VEP))
1574 return VPPCOM_EBADFD;
1576 listen_vpp_handle = listen_session->vpp_handle;
1577 if (listen_session->session_state == VCL_STATE_LISTEN)
1579 VDBG (0, "session %u [0x%llx]: already in listen state!",
1580 listen_sh, listen_vpp_handle);
1584 VDBG (0, "session %u: sending vpp listen request...", listen_sh);
1587 * Send listen request to vpp and wait for reply
1589 vcl_send_session_listen (wrk, listen_session);
1590 rv = vppcom_wait_for_session_state_change (listen_session->session_index,
1592 vcm->cfg.session_timeout);
1594 if (PREDICT_FALSE (rv))
1596 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1597 VDBG (0, "session %u [0x%llx]: listen failed! returning %d (%s)",
1598 listen_sh, listen_session->vpp_handle, rv,
1599 vppcom_retval_str (rv));
1607 validate_args_session_accept_ (vcl_worker_t * wrk, vcl_session_t * ls)
1609 if (ls->flags & VCL_SESSION_F_IS_VEP)
1611 VDBG (0, "ERROR: cannot accept on epoll session %u!",
1613 return VPPCOM_EBADFD;
1616 if ((ls->session_state != VCL_STATE_LISTEN)
1617 && (!vcl_session_is_connectable_listener (wrk, ls)))
1620 "ERROR: session [0x%llx]: not in listen state! state 0x%x"
1622 ls->vpp_handle, ls->session_state,
1623 vcl_session_state_str (ls->session_state));
1624 return VPPCOM_EBADFD;
1630 vppcom_unformat_proto (uint8_t * proto, char *proto_str)
1632 if (!strcmp (proto_str, "TCP"))
1633 *proto = VPPCOM_PROTO_TCP;
1634 else if (!strcmp (proto_str, "tcp"))
1635 *proto = VPPCOM_PROTO_TCP;
1636 else if (!strcmp (proto_str, "UDP"))
1637 *proto = VPPCOM_PROTO_UDP;
1638 else if (!strcmp (proto_str, "udp"))
1639 *proto = VPPCOM_PROTO_UDP;
1640 else if (!strcmp (proto_str, "TLS"))
1641 *proto = VPPCOM_PROTO_TLS;
1642 else if (!strcmp (proto_str, "tls"))
1643 *proto = VPPCOM_PROTO_TLS;
1644 else if (!strcmp (proto_str, "QUIC"))
1645 *proto = VPPCOM_PROTO_QUIC;
1646 else if (!strcmp (proto_str, "quic"))
1647 *proto = VPPCOM_PROTO_QUIC;
1648 else if (!strcmp (proto_str, "DTLS"))
1649 *proto = VPPCOM_PROTO_DTLS;
1650 else if (!strcmp (proto_str, "dtls"))
1651 *proto = VPPCOM_PROTO_DTLS;
1652 else if (!strcmp (proto_str, "SRTP"))
1653 *proto = VPPCOM_PROTO_SRTP;
1654 else if (!strcmp (proto_str, "srtp"))
1655 *proto = VPPCOM_PROTO_SRTP;
1662 vppcom_session_accept (uint32_t listen_session_handle, vppcom_endpt_t * ep,
1665 u32 client_session_index = ~0, listen_session_index, accept_flags = 0;
1666 vcl_worker_t *wrk = vcl_worker_get_current ();
1667 session_accepted_msg_t accepted_msg;
1668 vcl_session_t *listen_session = 0;
1669 vcl_session_t *client_session = 0;
1670 vcl_session_msg_t *evt;
1676 listen_session = vcl_session_get_w_handle (wrk, listen_session_handle);
1677 if (!listen_session)
1678 return VPPCOM_EBADFD;
1680 listen_session_index = listen_session->session_index;
1681 if ((rv = validate_args_session_accept_ (wrk, listen_session)))
1684 if (clib_fifo_elts (listen_session->accept_evts_fifo))
1686 clib_fifo_sub2 (listen_session->accept_evts_fifo, evt);
1687 accept_flags = evt->flags;
1688 accepted_msg = evt->accepted_msg;
1692 is_nonblocking = vcl_session_has_attr (listen_session,
1693 VCL_SESS_ATTR_NONBLOCK);
1696 if (svm_msg_q_is_empty (wrk->app_event_queue) && is_nonblocking)
1697 return VPPCOM_EAGAIN;
1699 svm_msg_q_wait (wrk->app_event_queue, SVM_MQ_WAIT_EMPTY);
1700 vcl_worker_flush_mq_events (wrk);
1706 client_session_index = vcl_session_accepted_handler (wrk, &accepted_msg,
1707 listen_session_index);
1708 if (client_session_index == VCL_INVALID_SESSION_INDEX)
1709 return VPPCOM_ECONNABORTED;
1711 listen_session = vcl_session_get (wrk, listen_session_index);
1712 client_session = vcl_session_get (wrk, client_session_index);
1714 if (flags & O_NONBLOCK)
1715 vcl_session_set_attr (client_session, VCL_SESS_ATTR_NONBLOCK);
1717 VDBG (1, "listener %u [0x%llx]: Got a connect request! session %u [0x%llx],"
1718 " flags %d, is_nonblocking %u", listen_session->session_index,
1719 listen_session->vpp_handle, client_session_index,
1720 client_session->vpp_handle, flags,
1721 vcl_session_has_attr (client_session, VCL_SESS_ATTR_NONBLOCK));
1725 ep->is_ip4 = client_session->transport.is_ip4;
1726 ep->port = client_session->transport.rmt_port;
1727 if (client_session->transport.is_ip4)
1728 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip4,
1729 sizeof (ip4_address_t));
1731 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip6,
1732 sizeof (ip6_address_t));
1736 "listener %u [0x%llx] accepted %u [0x%llx] peer: %U:%u "
1738 listen_session_handle, listen_session->vpp_handle,
1739 client_session_index, client_session->vpp_handle,
1740 vcl_format_ip46_address, &client_session->transport.rmt_ip,
1741 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1742 clib_net_to_host_u16 (client_session->transport.rmt_port),
1743 vcl_format_ip46_address, &client_session->transport.lcl_ip,
1744 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1745 clib_net_to_host_u16 (client_session->transport.lcl_port));
1746 vcl_evt (VCL_EVT_ACCEPT, client_session, listen_session,
1747 client_session_index);
1750 * Session might have been closed already
1754 if (accept_flags & VCL_ACCEPTED_F_CLOSED)
1755 client_session->session_state = VCL_STATE_VPP_CLOSING;
1756 else if (accept_flags & VCL_ACCEPTED_F_RESET)
1757 client_session->session_state = VCL_STATE_DISCONNECT;
1759 return vcl_session_handle (client_session);
1763 vppcom_session_connect (uint32_t session_handle, vppcom_endpt_t * server_ep)
1765 vcl_worker_t *wrk = vcl_worker_get_current ();
1766 vcl_session_t *session = 0;
1770 session = vcl_session_get_w_handle (wrk, session_handle);
1772 return VPPCOM_EBADFD;
1773 session_index = session->session_index;
1775 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1777 VWRN ("cannot connect epoll session %u!", session->session_index);
1778 return VPPCOM_EBADFD;
1781 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1784 "session %u [0x%llx]: already connected to %U:%d proto %s,"
1786 session->session_index, session->vpp_handle,
1787 vcl_format_ip46_address, &session->transport.rmt_ip,
1788 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1789 clib_net_to_host_u16 (session->transport.rmt_port),
1790 vppcom_proto_str (session->session_type),
1791 vcl_session_state_str (session->session_state));
1795 /* Attempt to connect a connectionless listener */
1796 if (PREDICT_FALSE (session->session_state == VCL_STATE_LISTEN))
1798 if (session->session_type != VPPCOM_PROTO_UDP)
1799 return VPPCOM_EINVAL;
1800 vcl_send_session_unlisten (wrk, session);
1801 session->session_state = VCL_STATE_CLOSED;
1804 session->transport.is_ip4 = server_ep->is_ip4;
1805 vcl_ip_copy_from_ep (&session->transport.rmt_ip, server_ep);
1806 session->transport.rmt_port = server_ep->port;
1807 session->parent_handle = VCL_INVALID_SESSION_HANDLE;
1808 session->flags |= VCL_SESSION_F_CONNECTED;
1810 VDBG (0, "session %u: connecting to peer %U:%d proto %s",
1811 session->session_index, vcl_format_ip46_address,
1812 &session->transport.rmt_ip,
1813 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1814 clib_net_to_host_u16 (session->transport.rmt_port),
1815 vppcom_proto_str (session->session_type));
1817 vcl_send_session_connect (wrk, session);
1819 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK))
1821 /* State set to STATE_UPDATED to ensure the session is not assumed
1822 * to be ready and to also allow the app to close it prior to vpp's
1823 * connected reply. */
1824 session->session_state = VCL_STATE_UPDATED;
1825 return VPPCOM_EINPROGRESS;
1829 * Wait for reply from vpp if blocking
1831 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1832 vcm->cfg.session_timeout);
1834 session = vcl_session_get (wrk, session_index);
1835 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1836 session->vpp_handle, rv ? "failed" : "succeeded");
1842 vppcom_session_stream_connect (uint32_t session_handle,
1843 uint32_t parent_session_handle)
1845 vcl_worker_t *wrk = vcl_worker_get_current ();
1846 vcl_session_t *session, *parent_session;
1847 u32 session_index, parent_session_index;
1850 session = vcl_session_get_w_handle (wrk, session_handle);
1852 return VPPCOM_EBADFD;
1853 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1854 if (!parent_session)
1855 return VPPCOM_EBADFD;
1857 session_index = session->session_index;
1858 parent_session_index = parent_session->session_index;
1859 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1861 VDBG (0, "ERROR: cannot connect epoll session %u!",
1862 session->session_index);
1863 return VPPCOM_EBADFD;
1866 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1869 "session handle %u [0x%llx]: session already "
1870 "connected to session %u [0x%llx] proto %s, state 0x%x (%s)",
1871 session_handle, session->vpp_handle, parent_session_handle,
1872 parent_session->vpp_handle,
1873 vppcom_proto_str (session->session_type), session->session_state,
1874 vcl_session_state_str (session->session_state));
1878 /* Connect to quic session specifics */
1879 session->transport.is_ip4 = parent_session->transport.is_ip4;
1880 session->transport.rmt_ip.ip4.as_u32 = (uint32_t) 1;
1881 session->transport.rmt_port = 0;
1882 session->parent_handle = parent_session->vpp_handle;
1884 VDBG (0, "session handle %u: connecting to session %u [0x%llx]",
1885 session_handle, parent_session_handle, parent_session->vpp_handle);
1888 * Send connect request and wait for reply from vpp
1890 vcl_send_session_connect (wrk, session);
1891 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1892 vcm->cfg.session_timeout);
1894 session->listener_index = parent_session_index;
1895 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1897 parent_session->n_accepted_sessions++;
1899 session = vcl_session_get (wrk, session_index);
1900 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1901 session->vpp_handle, rv ? "failed" : "succeeded");
1907 vppcom_session_read_internal (uint32_t session_handle, void *buf, int n,
1910 vcl_worker_t *wrk = vcl_worker_get_current ();
1911 int rv, n_read = 0, is_nonblocking;
1912 vcl_session_t *s = 0;
1913 svm_fifo_t *rx_fifo;
1918 if (PREDICT_FALSE (!buf))
1919 return VPPCOM_EFAULT;
1921 s = vcl_session_get_w_handle (wrk, session_handle);
1922 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
1923 return VPPCOM_EBADFD;
1925 if (PREDICT_FALSE (!vcl_session_is_open (s)))
1927 VDBG (0, "session %u[0x%llx] is not open! state 0x%x (%s)",
1928 s->session_index, s->vpp_handle, s->session_state,
1929 vcl_session_state_str (s->session_state));
1930 return vcl_session_closed_error (s);
1933 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_RD_SHUTDOWN))
1935 /* Vpp would ack the incoming data and enqueue it for reading.
1936 * So even if SHUT_RD is set, we can still read() the data if
1937 * the session is ready.
1939 if (!vcl_session_read_ready (s))
1945 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
1946 is_ct = vcl_session_is_ct (s);
1947 mq = wrk->app_event_queue;
1948 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
1949 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
1951 if (svm_fifo_is_empty_cons (rx_fifo))
1955 if (vcl_session_is_closing (s))
1956 return vcl_session_closing_error (s);
1958 svm_fifo_unset_event (s->rx_fifo);
1959 svm_fifo_unset_event (rx_fifo);
1960 return VPPCOM_EWOULDBLOCK;
1962 while (svm_fifo_is_empty_cons (rx_fifo))
1964 if (vcl_session_is_closing (s))
1965 return vcl_session_closing_error (s);
1968 svm_fifo_unset_event (s->rx_fifo);
1969 svm_fifo_unset_event (rx_fifo);
1971 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
1972 vcl_worker_flush_mq_events (wrk);
1979 rv = app_recv_dgram_raw (rx_fifo, buf, n, &s->transport, 0, peek);
1981 rv = app_recv_stream_raw (rx_fifo, buf, n, 0, peek);
1990 if (svm_fifo_is_empty_cons (rx_fifo))
1993 svm_fifo_unset_event (s->rx_fifo);
1994 svm_fifo_unset_event (rx_fifo);
1995 if (!svm_fifo_is_empty_cons (rx_fifo)
1996 && svm_fifo_set_event (rx_fifo) && is_nonblocking)
1998 vec_add2 (wrk->unhandled_evts_vector, e, 1);
1999 e->event_type = SESSION_IO_EVT_RX;
2000 e->session_index = s->session_index;
2003 else if (PREDICT_FALSE (rv < n && !s->is_dgram))
2005 /* More data enqueued while reading. Try to drain it
2006 * or fill the buffer. Avoid doing that for dgrams */
2012 if (PREDICT_FALSE (svm_fifo_needs_deq_ntf (rx_fifo, n_read)))
2014 svm_fifo_clear_deq_ntf (rx_fifo);
2015 app_send_io_evt_to_vpp (s->vpp_evt_q,
2016 s->rx_fifo->shr->master_session_index,
2017 SESSION_IO_EVT_RX, SVM_Q_WAIT);
2020 VDBG (2, "session %u[0x%llx]: read %d bytes from (%p)", s->session_index,
2021 s->vpp_handle, n_read, rx_fifo);
2027 vppcom_session_read (uint32_t session_handle, void *buf, size_t n)
2029 return (vppcom_session_read_internal (session_handle, buf, n, 0));
2033 vppcom_session_peek (uint32_t session_handle, void *buf, int n)
2035 return (vppcom_session_read_internal (session_handle, buf, n, 1));
2039 vppcom_session_read_segments (uint32_t session_handle,
2040 vppcom_data_segment_t * ds, uint32_t n_segments,
2043 vcl_worker_t *wrk = vcl_worker_get_current ();
2044 int n_read = 0, is_nonblocking;
2045 vcl_session_t *s = 0;
2046 svm_fifo_t *rx_fifo;
2050 s = vcl_session_get_w_handle (wrk, session_handle);
2051 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2052 return VPPCOM_EBADFD;
2054 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2055 return vcl_session_closed_error (s);
2057 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2058 is_ct = vcl_session_is_ct (s);
2059 mq = wrk->app_event_queue;
2060 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
2061 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2063 if (svm_fifo_is_empty_cons (rx_fifo))
2068 svm_fifo_unset_event (s->rx_fifo);
2069 svm_fifo_unset_event (rx_fifo);
2070 return VPPCOM_EWOULDBLOCK;
2072 while (svm_fifo_is_empty_cons (rx_fifo))
2074 if (vcl_session_is_closing (s))
2075 return vcl_session_closing_error (s);
2078 svm_fifo_unset_event (s->rx_fifo);
2079 svm_fifo_unset_event (rx_fifo);
2081 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2082 vcl_worker_flush_mq_events (wrk);
2086 n_read = svm_fifo_segments (rx_fifo, s->rx_bytes_pending,
2087 (svm_fifo_seg_t *) ds, n_segments, max_bytes);
2089 return VPPCOM_EAGAIN;
2091 if (svm_fifo_max_dequeue_cons (rx_fifo) == n_read)
2094 svm_fifo_unset_event (s->rx_fifo);
2095 svm_fifo_unset_event (rx_fifo);
2096 if (svm_fifo_max_dequeue_cons (rx_fifo) != n_read
2097 && svm_fifo_set_event (rx_fifo)
2098 && vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
2101 vec_add2 (wrk->unhandled_evts_vector, e, 1);
2102 e->event_type = SESSION_IO_EVT_RX;
2103 e->session_index = s->session_index;
2107 s->rx_bytes_pending += n_read;
2112 vppcom_session_free_segments (uint32_t session_handle, uint32_t n_bytes)
2114 vcl_worker_t *wrk = vcl_worker_get_current ();
2118 s = vcl_session_get_w_handle (wrk, session_handle);
2119 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2122 is_ct = vcl_session_is_ct (s);
2123 svm_fifo_dequeue_drop (is_ct ? s->ct_rx_fifo : s->rx_fifo, n_bytes);
2125 ASSERT (s->rx_bytes_pending >= n_bytes);
2126 s->rx_bytes_pending -= n_bytes;
2130 vcl_fifo_is_writeable (svm_fifo_t * f, u32 len, u8 is_dgram)
2132 u32 max_enq = svm_fifo_max_enqueue_prod (f);
2134 return max_enq >= (sizeof (session_dgram_hdr_t) + len);
2140 vppcom_session_write_inline (vcl_worker_t * wrk, vcl_session_t * s, void *buf,
2141 size_t n, u8 is_flush, u8 is_dgram)
2143 int n_write, is_nonblocking;
2144 session_evt_type_t et;
2145 svm_fifo_t *tx_fifo;
2149 /* Accept zero length writes but just return */
2150 if (PREDICT_FALSE (!n))
2153 if (PREDICT_FALSE (!buf))
2154 return VPPCOM_EFAULT;
2156 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2158 VDBG (0, "ERROR: session %u [0x%llx]: cannot write to an epoll"
2159 " session!", s->session_index, s->vpp_handle);
2160 return VPPCOM_EBADFD;
2163 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2165 VDBG (1, "session %u [0x%llx]: is not open! state 0x%x (%s)",
2166 s->session_index, s->vpp_handle, s->session_state,
2167 vcl_session_state_str (s->session_state));
2168 return vcl_session_closed_error (s);;
2171 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_WR_SHUTDOWN))
2173 VDBG (1, "session %u [0x%llx]: is shutdown! state 0x%x (%s)",
2174 s->session_index, s->vpp_handle, s->session_state,
2175 vcl_session_state_str (s->session_state));
2176 return VPPCOM_EPIPE;
2179 is_ct = vcl_session_is_ct (s);
2180 tx_fifo = is_ct ? s->ct_tx_fifo : s->tx_fifo;
2181 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2183 mq = wrk->app_event_queue;
2184 if (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2188 return VPPCOM_EWOULDBLOCK;
2190 while (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2192 svm_fifo_add_want_deq_ntf (tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
2193 if (vcl_session_is_closing (s))
2194 return vcl_session_closing_error (s);
2196 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2197 vcl_worker_flush_mq_events (wrk);
2201 et = SESSION_IO_EVT_TX;
2202 if (is_flush && !is_ct)
2203 et = SESSION_IO_EVT_TX_FLUSH;
2206 n_write = app_send_dgram_raw (tx_fifo, &s->transport,
2207 s->vpp_evt_q, buf, n, et,
2208 0 /* do_evt */ , SVM_Q_WAIT);
2210 n_write = app_send_stream_raw (tx_fifo, s->vpp_evt_q, buf, n, et,
2211 0 /* do_evt */ , SVM_Q_WAIT);
2213 if (svm_fifo_set_event (s->tx_fifo))
2214 app_send_io_evt_to_vpp (
2215 s->vpp_evt_q, s->tx_fifo->shr->master_session_index, et, SVM_Q_WAIT);
2217 /* The underlying fifo segment can run out of memory */
2218 if (PREDICT_FALSE (n_write < 0))
2219 return VPPCOM_EAGAIN;
2221 VDBG (2, "session %u [0x%llx]: wrote %d bytes", s->session_index,
2222 s->vpp_handle, n_write);
2228 vppcom_session_write (uint32_t session_handle, void *buf, size_t n)
2230 vcl_worker_t *wrk = vcl_worker_get_current ();
2233 s = vcl_session_get_w_handle (wrk, session_handle);
2234 if (PREDICT_FALSE (!s))
2235 return VPPCOM_EBADFD;
2237 return vppcom_session_write_inline (wrk, s, buf, n,
2238 0 /* is_flush */ , s->is_dgram ? 1 : 0);
2242 vppcom_session_write_msg (uint32_t session_handle, void *buf, size_t n)
2244 vcl_worker_t *wrk = vcl_worker_get_current ();
2247 s = vcl_session_get_w_handle (wrk, session_handle);
2248 if (PREDICT_FALSE (!s))
2249 return VPPCOM_EBADFD;
2251 return vppcom_session_write_inline (wrk, s, buf, n,
2252 1 /* is_flush */ , s->is_dgram ? 1 : 0);
2255 #define vcl_fifo_rx_evt_valid_or_break(_s) \
2256 if (PREDICT_FALSE (!_s->rx_fifo)) \
2258 if (PREDICT_FALSE (svm_fifo_is_empty (_s->rx_fifo))) \
2260 if (!vcl_session_is_ct (_s)) \
2262 svm_fifo_unset_event (_s->rx_fifo); \
2263 if (svm_fifo_is_empty (_s->rx_fifo)) \
2266 else if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2268 svm_fifo_unset_event (_s->rx_fifo); /* rx evts on actual fifo*/ \
2269 if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2275 vcl_select_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2276 unsigned long n_bits, unsigned long *read_map,
2277 unsigned long *write_map,
2278 unsigned long *except_map, u32 * bits_set)
2280 session_disconnected_msg_t *disconnected_msg;
2281 session_connected_msg_t *connected_msg;
2285 switch (e->event_type)
2287 case SESSION_IO_EVT_RX:
2288 sid = e->session_index;
2289 s = vcl_session_get (wrk, sid);
2290 if (!s || !vcl_session_is_open (s))
2292 vcl_fifo_rx_evt_valid_or_break (s);
2293 if (sid < n_bits && read_map)
2295 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2299 case SESSION_IO_EVT_TX:
2300 sid = e->session_index;
2301 s = vcl_session_get (wrk, sid);
2302 if (!s || !vcl_session_is_open (s))
2304 if (sid < n_bits && write_map)
2306 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2310 case SESSION_CTRL_EVT_ACCEPTED:
2312 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
2314 s = vcl_session_get (wrk, e->session_index);
2317 sid = s->session_index;
2318 if (sid < n_bits && read_map)
2320 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2324 case SESSION_CTRL_EVT_CONNECTED:
2327 connected_msg = (session_connected_msg_t *) e->data;
2328 sid = vcl_session_connected_handler (wrk, connected_msg);
2331 sid = e->session_index;
2332 if (sid == VCL_INVALID_SESSION_INDEX)
2334 if (sid < n_bits && write_map)
2336 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2340 case SESSION_CTRL_EVT_DISCONNECTED:
2341 disconnected_msg = (session_disconnected_msg_t *) e->data;
2342 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
2345 sid = s->session_index;
2346 if (sid < n_bits && except_map)
2348 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2352 case SESSION_CTRL_EVT_RESET:
2353 sid = vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
2354 if (sid < n_bits && except_map)
2356 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2360 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
2361 vcl_session_unlisten_reply_handler (wrk, e->data);
2363 case SESSION_CTRL_EVT_MIGRATED:
2364 vcl_session_migrated_handler (wrk, e->data);
2366 case SESSION_CTRL_EVT_CLEANUP:
2367 vcl_session_cleanup_handler (wrk, e->data);
2369 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
2370 vcl_session_worker_update_reply_handler (wrk, e->data);
2372 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
2373 vcl_session_req_worker_update_handler (wrk, e->data);
2375 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
2376 vcl_session_app_add_segment_handler (wrk, e->data);
2378 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
2379 vcl_session_app_del_segment_handler (wrk, e->data);
2381 case SESSION_CTRL_EVT_APP_WRK_RPC:
2382 vcl_worker_rpc_handler (wrk, e->data);
2385 clib_warning ("unhandled: %u", e->event_type);
2391 vcl_select_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
2392 unsigned long n_bits, unsigned long *read_map,
2393 unsigned long *write_map, unsigned long *except_map,
2394 double time_to_wait, u32 * bits_set)
2396 svm_msg_q_msg_t *msg;
2400 if (svm_msg_q_is_empty (mq))
2407 else if (time_to_wait < 0)
2408 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2411 if (svm_msg_q_timedwait (mq, time_to_wait))
2415 vcl_mq_dequeue_batch (wrk, mq, ~0);
2417 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
2419 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
2420 e = svm_msg_q_msg_data (mq, msg);
2421 vcl_select_handle_mq_event (wrk, e, n_bits, read_map, write_map,
2422 except_map, bits_set);
2423 svm_msg_q_free_msg (mq, msg);
2425 vec_reset_length (wrk->mq_msg_vector);
2426 vcl_handle_pending_wrk_updates (wrk);
2431 vppcom_select_condvar (vcl_worker_t * wrk, int n_bits,
2432 vcl_si_set * read_map, vcl_si_set * write_map,
2433 vcl_si_set * except_map, double time_to_wait,
2436 double wait = 0, start = 0;
2440 wait = time_to_wait;
2441 start = clib_time_now (&wrk->clib_time);
2446 vcl_select_handle_mq (wrk, wrk->app_event_queue, n_bits, read_map,
2447 write_map, except_map, wait, bits_set);
2453 wait = wait - (clib_time_now (&wrk->clib_time) - start);
2461 vppcom_select_eventfd (vcl_worker_t * wrk, int n_bits,
2462 vcl_si_set * read_map, vcl_si_set * write_map,
2463 vcl_si_set * except_map, double time_to_wait,
2466 vcl_mq_evt_conn_t *mqc;
2467 int __clib_unused n_read;
2471 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
2472 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
2473 vec_len (wrk->mq_events), time_to_wait);
2474 for (i = 0; i < n_mq_evts; i++)
2476 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
2477 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
2478 vcl_select_handle_mq (wrk, mqc->mq, n_bits, read_map, write_map,
2479 except_map, 0, bits_set);
2482 return (n_mq_evts > 0 ? (int) *bits_set : 0);
2486 vppcom_select (int n_bits, vcl_si_set * read_map, vcl_si_set * write_map,
2487 vcl_si_set * except_map, double time_to_wait)
2489 u32 sid, minbits = clib_max (n_bits, BITS (uword)), bits_set = 0;
2490 vcl_worker_t *wrk = vcl_worker_get_current ();
2491 vcl_session_t *s = 0;
2494 if (n_bits && read_map)
2496 clib_bitmap_validate (wrk->rd_bitmap, minbits);
2497 clib_memcpy_fast (wrk->rd_bitmap, read_map,
2498 vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2499 memset (read_map, 0, vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2501 if (n_bits && write_map)
2503 clib_bitmap_validate (wrk->wr_bitmap, minbits);
2504 clib_memcpy_fast (wrk->wr_bitmap, write_map,
2505 vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2506 memset (write_map, 0, vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2508 if (n_bits && except_map)
2510 clib_bitmap_validate (wrk->ex_bitmap, minbits);
2511 clib_memcpy_fast (wrk->ex_bitmap, except_map,
2512 vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2513 memset (except_map, 0, vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2522 clib_bitmap_foreach (sid, wrk->wr_bitmap)
2524 if (!(s = vcl_session_get (wrk, sid)))
2526 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2531 if (vcl_session_write_ready (s))
2533 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2538 svm_fifo_t *txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2539 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF);
2547 clib_bitmap_foreach (sid, wrk->rd_bitmap)
2549 if (!(s = vcl_session_get (wrk, sid)))
2551 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2556 if (vcl_session_read_ready (s))
2558 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2565 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
2567 vcl_select_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i], n_bits,
2568 read_map, write_map, except_map, &bits_set);
2570 vec_reset_length (wrk->unhandled_evts_vector);
2572 if (vcm->cfg.use_mq_eventfd)
2573 vppcom_select_eventfd (wrk, n_bits, read_map, write_map, except_map,
2574 time_to_wait, &bits_set);
2576 vppcom_select_condvar (wrk, n_bits, read_map, write_map, except_map,
2577 time_to_wait, &bits_set);
2583 vep_verify_epoll_chain (vcl_worker_t * wrk, u32 vep_handle)
2585 vppcom_epoll_t *vep;
2586 u32 sh = vep_handle;
2589 if (VPPCOM_DEBUG <= 2)
2592 s = vcl_session_get_w_handle (wrk, vep_handle);
2593 if (PREDICT_FALSE (!s))
2595 VDBG (0, "ERROR: Invalid vep_sh (%u)!", vep_handle);
2598 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP)))
2600 VDBG (0, "ERROR: vep_sh (%u) is not a vep!", vep_handle);
2604 VDBG (0, "vep_sh (%u): Dumping epoll chain\n"
2607 " is_vep_session = %u\n"
2608 " next_sh = 0x%x (%u)\n"
2609 "}\n", vep_handle, s->flags & VCL_SESSION_F_IS_VEP,
2610 s->flags & VCL_SESSION_F_IS_VEP_SESSION, vep->next_sh, vep->next_sh);
2612 for (sh = vep->next_sh; sh != ~0; sh = vep->next_sh)
2614 s = vcl_session_get_w_handle (wrk, sh);
2615 if (PREDICT_FALSE (!s))
2617 VDBG (0, "ERROR: Invalid sh (%u)!", sh);
2620 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2622 VDBG (0, "ERROR: sh (%u) is a vep!", vep_handle);
2624 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2626 VDBG (0, "ERROR: sh (%u) is not a vep session handle!", sh);
2630 if (PREDICT_FALSE (vep->vep_sh != vep_handle))
2631 VDBG (0, "ERROR: session (%u) vep_sh (%u) != vep_sh (%u)!",
2632 sh, s->vep.vep_sh, vep_handle);
2633 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2635 VDBG (0, "vep_sh[%u]: sh 0x%x (%u)\n"
2637 " next_sh = 0x%x (%u)\n"
2638 " prev_sh = 0x%x (%u)\n"
2639 " vep_sh = 0x%x (%u)\n"
2640 " ev.events = 0x%x\n"
2641 " ev.data.u64 = 0x%llx\n"
2644 vep_handle, sh, sh, vep->next_sh, vep->next_sh, vep->prev_sh,
2645 vep->prev_sh, vep->vep_sh, vep->vep_sh, vep->ev.events,
2646 vep->ev.data.u64, vep->et_mask);
2651 VDBG (0, "vep_sh (%u): Dump complete!\n", vep_handle);
2655 vppcom_epoll_create (void)
2657 vcl_worker_t *wrk = vcl_worker_get_current ();
2658 vcl_session_t *vep_session;
2660 vep_session = vcl_session_alloc (wrk);
2662 vep_session->flags |= VCL_SESSION_F_IS_VEP;
2663 vep_session->vep.vep_sh = ~0;
2664 vep_session->vep.next_sh = ~0;
2665 vep_session->vep.prev_sh = ~0;
2666 vep_session->vpp_handle = ~0;
2668 vcl_evt (VCL_EVT_EPOLL_CREATE, vep_session, vep_session->session_index);
2669 VDBG (0, "Created vep_idx %u", vep_session->session_index);
2671 return vcl_session_handle (vep_session);
2675 vppcom_epoll_ctl (uint32_t vep_handle, int op, uint32_t session_handle,
2676 struct epoll_event *event)
2678 vcl_worker_t *wrk = vcl_worker_get_current ();
2679 int rv = VPPCOM_OK, add_evt = 0;
2680 vcl_session_t *vep_session;
2684 if (vep_handle == session_handle)
2686 VDBG (0, "vep_sh == session handle (%u)!", vep_handle);
2687 return VPPCOM_EINVAL;
2690 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
2691 if (PREDICT_FALSE (!vep_session))
2693 VDBG (0, "Invalid vep_sh (%u)!", vep_handle);
2694 return VPPCOM_EBADFD;
2696 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
2698 VDBG (0, "vep_sh (%u) is not a vep!", vep_handle);
2699 return VPPCOM_EINVAL;
2702 ASSERT (vep_session->vep.vep_sh == ~0);
2703 ASSERT (vep_session->vep.prev_sh == ~0);
2705 s = vcl_session_get_w_handle (wrk, session_handle);
2706 if (PREDICT_FALSE (!s))
2708 VDBG (0, "Invalid session_handle (%u)!", session_handle);
2709 return VPPCOM_EBADFD;
2711 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2713 VDBG (0, "session_handle (%u) is a vep!", vep_handle);
2714 return VPPCOM_EINVAL;
2720 if (PREDICT_FALSE (!event))
2722 VDBG (0, "EPOLL_CTL_ADD: NULL pointer to epoll_event structure!");
2723 return VPPCOM_EINVAL;
2725 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2727 VDBG (0, "EPOLL_CTL_ADD: %u already epolled!", s->session_index);
2731 if (vep_session->vep.next_sh != ~0)
2733 vcl_session_t *next_session;
2734 next_session = vcl_session_get_w_handle (wrk,
2735 vep_session->vep.next_sh);
2736 if (PREDICT_FALSE (!next_session))
2738 VDBG (0, "EPOLL_CTL_ADD: Invalid vep.next_sh (%u) on "
2739 "vep_idx (%u)!", vep_session->vep.next_sh, vep_handle);
2740 return VPPCOM_EBADFD;
2742 ASSERT (next_session->vep.prev_sh == vep_handle);
2743 next_session->vep.prev_sh = session_handle;
2745 s->vep.next_sh = vep_session->vep.next_sh;
2746 s->vep.prev_sh = vep_handle;
2747 s->vep.vep_sh = vep_handle;
2748 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2749 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
2751 s->flags &= ~VCL_SESSION_F_IS_VEP;
2752 s->flags |= VCL_SESSION_F_IS_VEP_SESSION;
2753 vep_session->vep.next_sh = session_handle;
2755 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2756 if (txf && (event->events & EPOLLOUT))
2757 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2759 /* Generate EPOLLOUT if tx fifo not full */
2760 if ((event->events & EPOLLOUT) && (vcl_session_write_ready (s) > 0))
2762 session_event_t e = { 0 };
2763 e.event_type = SESSION_IO_EVT_TX;
2764 e.session_index = s->session_index;
2765 vec_add1 (wrk->unhandled_evts_vector, e);
2768 /* Generate EPOLLIN if rx fifo has data */
2769 if ((event->events & EPOLLIN) && (vcl_session_read_ready (s) > 0))
2771 session_event_t e = { 0 };
2772 e.event_type = SESSION_IO_EVT_RX;
2773 e.session_index = s->session_index;
2774 vec_add1 (wrk->unhandled_evts_vector, e);
2775 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2778 if (!add_evt && vcl_session_is_closing (s))
2780 session_event_t e = { 0 };
2781 if (s->session_state == VCL_STATE_VPP_CLOSING)
2782 e.event_type = SESSION_CTRL_EVT_DISCONNECTED;
2784 e.event_type = SESSION_CTRL_EVT_RESET;
2785 e.session_index = s->session_index;
2787 vec_add1 (wrk->unhandled_evts_vector, e);
2789 VDBG (1, "EPOLL_CTL_ADD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2790 vep_handle, session_handle, event->events, event->data.u64);
2791 vcl_evt (VCL_EVT_EPOLL_CTLADD, s, event->events, event->data.u64);
2795 if (PREDICT_FALSE (!event))
2797 VDBG (0, "EPOLL_CTL_MOD: NULL pointer to epoll_event structure!");
2801 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2803 VDBG (0, "sh %u EPOLL_CTL_MOD: not a vep session!", session_handle);
2807 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2809 VDBG (0, "EPOLL_CTL_MOD: sh %u vep_sh (%u) != vep_sh (%u)!",
2810 session_handle, s->vep.vep_sh, vep_handle);
2815 /* Generate EPOLLOUT if session write ready nd event was not on */
2816 if ((event->events & EPOLLOUT) && !(s->vep.ev.events & EPOLLOUT) &&
2817 (vcl_session_write_ready (s) > 0))
2819 session_event_t e = { 0 };
2820 e.event_type = SESSION_IO_EVT_TX;
2821 e.session_index = s->session_index;
2822 vec_add1 (wrk->unhandled_evts_vector, e);
2824 /* Generate EPOLLIN if session read ready and event was not on */
2825 if ((event->events & EPOLLIN) && !(s->vep.ev.events & EPOLLIN) &&
2826 (vcl_session_read_ready (s) > 0))
2828 session_event_t e = { 0 };
2829 e.event_type = SESSION_IO_EVT_RX;
2830 e.session_index = s->session_index;
2831 vec_add1 (wrk->unhandled_evts_vector, e);
2832 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2834 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2836 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2839 if (event->events & EPOLLOUT)
2840 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2842 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2844 VDBG (1, "EPOLL_CTL_MOD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2845 vep_handle, session_handle, event->events, event->data.u64);
2849 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2851 VDBG (0, "EPOLL_CTL_DEL: %u not a vep session!", session_handle);
2855 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2857 VDBG (0, "EPOLL_CTL_DEL: sh %u vep_sh (%u) != vep_sh (%u)!",
2858 session_handle, s->vep.vep_sh, vep_handle);
2863 if (s->vep.prev_sh == vep_handle)
2864 vep_session->vep.next_sh = s->vep.next_sh;
2867 vcl_session_t *prev_session;
2868 prev_session = vcl_session_get_w_handle (wrk, s->vep.prev_sh);
2869 if (PREDICT_FALSE (!prev_session))
2871 VDBG (0, "EPOLL_CTL_DEL: Invalid prev_sh (%u) on sh (%u)!",
2872 s->vep.prev_sh, session_handle);
2873 return VPPCOM_EBADFD;
2875 ASSERT (prev_session->vep.next_sh == session_handle);
2876 prev_session->vep.next_sh = s->vep.next_sh;
2878 if (s->vep.next_sh != ~0)
2880 vcl_session_t *next_session;
2881 next_session = vcl_session_get_w_handle (wrk, s->vep.next_sh);
2882 if (PREDICT_FALSE (!next_session))
2884 VDBG (0, "EPOLL_CTL_DEL: Invalid next_sh (%u) on sh (%u)!",
2885 s->vep.next_sh, session_handle);
2886 return VPPCOM_EBADFD;
2888 ASSERT (next_session->vep.prev_sh == session_handle);
2889 next_session->vep.prev_sh = s->vep.prev_sh;
2892 if (s->vep.lt_next != VCL_INVALID_SESSION_INDEX)
2893 vcl_epoll_lt_del (wrk, s);
2895 memset (&s->vep, 0, sizeof (s->vep));
2896 s->vep.next_sh = ~0;
2897 s->vep.prev_sh = ~0;
2899 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
2900 s->flags &= ~VCL_SESSION_F_IS_VEP_SESSION;
2902 if (vcl_session_is_open (s))
2904 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2906 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2909 VDBG (1, "EPOLL_CTL_DEL: vep_idx %u, sh %u!", vep_handle,
2911 vcl_evt (VCL_EVT_EPOLL_CTLDEL, s, vep_sh);
2915 VDBG (0, "Invalid operation (%d)!", op);
2919 vep_verify_epoll_chain (wrk, vep_handle);
2926 vcl_epoll_wait_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2927 struct epoll_event *events, u32 * num_ev)
2929 session_disconnected_msg_t *disconnected_msg;
2930 session_connected_msg_t *connected_msg;
2931 u32 sid = ~0, session_events;
2932 u64 session_evt_data = ~0;
2936 switch (e->event_type)
2938 case SESSION_IO_EVT_RX:
2939 sid = e->session_index;
2940 s = vcl_session_get (wrk, sid);
2941 if (vcl_session_is_closed (s))
2943 vcl_fifo_rx_evt_valid_or_break (s);
2944 session_events = s->vep.ev.events;
2945 if (!(EPOLLIN & s->vep.ev.events) ||
2946 (s->flags & VCL_SESSION_F_HAS_RX_EVT) ||
2947 (s->vep.lt_next != VCL_INVALID_SESSION_INDEX))
2950 events[*num_ev].events = EPOLLIN;
2951 session_evt_data = s->vep.ev.data.u64;
2952 s->flags |= VCL_SESSION_F_HAS_RX_EVT;
2954 case SESSION_IO_EVT_TX:
2955 sid = e->session_index;
2956 s = vcl_session_get (wrk, sid);
2957 if (!s || !vcl_session_is_open (s))
2959 session_events = s->vep.ev.events;
2960 if (!(EPOLLOUT & session_events))
2963 events[*num_ev].events = EPOLLOUT;
2964 session_evt_data = s->vep.ev.data.u64;
2965 svm_fifo_reset_has_deq_ntf (vcl_session_is_ct (s) ?
2966 s->ct_tx_fifo : s->tx_fifo);
2968 case SESSION_CTRL_EVT_ACCEPTED:
2970 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
2972 s = vcl_session_get (wrk, e->session_index);
2975 session_events = s->vep.ev.events;
2976 sid = s->session_index;
2977 if (!(EPOLLIN & session_events) ||
2978 (s->vep.lt_next != VCL_INVALID_SESSION_INDEX))
2981 events[*num_ev].events = EPOLLIN;
2982 session_evt_data = s->vep.ev.data.u64;
2984 case SESSION_CTRL_EVT_CONNECTED:
2987 connected_msg = (session_connected_msg_t *) e->data;
2988 sid = vcl_session_connected_handler (wrk, connected_msg);
2991 sid = e->session_index;
2992 s = vcl_session_get (wrk, sid);
2993 if (vcl_session_is_closed (s))
2995 session_events = s->vep.ev.events;
2996 /* Generate EPOLLOUT because there's no connected event */
2997 if (!(EPOLLOUT & session_events))
3000 events[*num_ev].events = EPOLLOUT;
3001 session_evt_data = s->vep.ev.data.u64;
3002 if (s->session_state == VCL_STATE_DETACHED)
3003 events[*num_ev].events |= EPOLLHUP;
3005 case SESSION_CTRL_EVT_DISCONNECTED:
3008 disconnected_msg = (session_disconnected_msg_t *) e->data;
3009 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
3013 s = vcl_session_get (wrk, e->session_index);
3014 s->flags &= ~VCL_SESSION_F_PENDING_DISCONNECT;
3016 if (vcl_session_is_closed (s) ||
3017 !(s->flags & VCL_SESSION_F_IS_VEP_SESSION))
3019 if (s && (s->flags & VCL_SESSION_F_PENDING_FREE))
3020 vcl_session_free (wrk, s);
3023 sid = s->session_index;
3024 session_events = s->vep.ev.events;
3026 if (EPOLLRDHUP & session_events)
3028 /* If app can distinguish between RDHUP and HUP,
3029 * we make finer control */
3030 events[*num_ev].events = EPOLLRDHUP;
3031 if (s->flags & VCL_SESSION_F_WR_SHUTDOWN)
3033 events[*num_ev].events |= EPOLLHUP;
3038 events[*num_ev].events = EPOLLHUP;
3040 session_evt_data = s->vep.ev.data.u64;
3043 case SESSION_CTRL_EVT_RESET:
3047 vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
3048 s = vcl_session_get (wrk, sid);
3052 sid = e->session_index;
3053 s = vcl_session_get (wrk, sid);
3054 s->flags &= ~VCL_SESSION_F_PENDING_DISCONNECT;
3056 if (vcl_session_is_closed (s) ||
3057 !(s->flags & VCL_SESSION_F_IS_VEP_SESSION))
3059 if (s && (s->flags & VCL_SESSION_F_PENDING_FREE))
3060 vcl_session_free (wrk, s);
3063 session_events = s->vep.ev.events;
3065 events[*num_ev].events = EPOLLHUP | EPOLLRDHUP;
3066 session_evt_data = s->vep.ev.data.u64;
3068 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
3069 vcl_session_unlisten_reply_handler (wrk, e->data);
3071 case SESSION_CTRL_EVT_MIGRATED:
3072 vcl_session_migrated_handler (wrk, e->data);
3074 case SESSION_CTRL_EVT_CLEANUP:
3075 vcl_session_cleanup_handler (wrk, e->data);
3077 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
3078 vcl_session_req_worker_update_handler (wrk, e->data);
3080 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
3081 vcl_session_worker_update_reply_handler (wrk, e->data);
3083 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
3084 vcl_session_app_add_segment_handler (wrk, e->data);
3086 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
3087 vcl_session_app_del_segment_handler (wrk, e->data);
3089 case SESSION_CTRL_EVT_APP_WRK_RPC:
3090 vcl_worker_rpc_handler (wrk, e->data);
3093 VDBG (0, "unhandled: %u", e->event_type);
3099 events[*num_ev].data.u64 = session_evt_data;
3100 if (EPOLLONESHOT & session_events)
3102 s = vcl_session_get (wrk, sid);
3103 s->vep.ev.events = 0;
3105 else if (!(EPOLLET & session_events))
3107 s = vcl_session_get (wrk, sid);
3108 if (s->vep.lt_next == VCL_INVALID_SESSION_INDEX)
3109 vcl_epoll_lt_add (wrk, s);
3116 vcl_epoll_wait_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
3117 struct epoll_event *events, u32 maxevents,
3118 double wait_for_time, u32 * num_ev)
3120 svm_msg_q_msg_t *msg;
3124 if (vec_len (wrk->mq_msg_vector) && svm_msg_q_is_empty (mq))
3125 goto handle_dequeued;
3127 if (svm_msg_q_is_empty (mq))
3131 else if (wait_for_time < 0)
3132 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
3135 if (svm_msg_q_timedwait (mq, wait_for_time / 1e3))
3139 ASSERT (maxevents > *num_ev);
3140 vcl_mq_dequeue_batch (wrk, mq, ~0);
3143 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
3145 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
3146 e = svm_msg_q_msg_data (mq, msg);
3147 if (*num_ev < maxevents)
3148 vcl_epoll_wait_handle_mq_event (wrk, e, events, num_ev);
3150 vcl_handle_mq_event (wrk, e);
3151 svm_msg_q_free_msg (mq, msg);
3153 vec_reset_length (wrk->mq_msg_vector);
3154 vcl_handle_pending_wrk_updates (wrk);
3159 vppcom_epoll_wait_condvar (vcl_worker_t *wrk, struct epoll_event *events,
3160 int maxevents, u32 n_evts, double timeout_ms)
3167 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3172 vcl_epoll_wait_handle_mq (wrk, wrk->app_event_queue, events, maxevents,
3173 timeout_ms, &n_evts);
3174 if (n_evts || !timeout_ms)
3177 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3183 vppcom_epoll_wait_eventfd (vcl_worker_t *wrk, struct epoll_event *events,
3184 int maxevents, u32 n_evts, double timeout_ms)
3186 int __clib_unused n_read;
3187 vcl_mq_evt_conn_t *mqc;
3192 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
3196 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3201 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
3202 vec_len (wrk->mq_events), timeout_ms);
3205 VDBG (0, "epoll_wait error %u", errno);
3209 for (i = 0; i < n_mq_evts; i++)
3211 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
3212 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
3213 vcl_epoll_wait_handle_mq (wrk, mqc->mq, events, maxevents, 0,
3217 if (n_evts || !timeout_ms)
3220 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3226 vcl_epoll_wait_handle_lt (vcl_worker_t *wrk, struct epoll_event *events,
3227 int maxevents, u32 *n_evts)
3229 u32 add_event = 0, next;
3234 ASSERT (wrk->ep_lt_current != VCL_INVALID_SESSION_INDEX);
3235 if (*n_evts >= maxevents)
3238 next = wrk->ep_lt_current;
3241 s = vcl_session_get (wrk, next);
3242 next = s->vep.lt_next;
3244 if ((s->vep.ev.events & EPOLLIN) && (rv = vcl_session_read_ready (s)))
3247 events[*n_evts].events |= rv > 0 ? EPOLLIN : EPOLLHUP | EPOLLRDHUP;
3248 evt_data = s->vep.ev.data.u64;
3250 if ((s->vep.ev.events & EPOLLOUT) && (rv = vcl_session_write_ready (s)))
3253 events[*n_evts].events |= rv > 0 ? EPOLLOUT : EPOLLHUP | EPOLLRDHUP;
3254 evt_data = s->vep.ev.data.u64;
3256 if (!add_event && s->session_state > VCL_STATE_READY)
3259 events[*n_evts].events |= EPOLLHUP | EPOLLRDHUP;
3260 evt_data = s->vep.ev.data.u64;
3264 events[*n_evts].data.u64 = evt_data;
3267 if (EPOLLONESHOT & s->vep.ev.events)
3268 s->vep.ev.events = 0;
3269 if (*n_evts == maxevents)
3271 wrk->ep_lt_current = next;
3277 vcl_epoll_lt_del (wrk, s);
3278 if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX)
3282 while (next != wrk->ep_lt_current);
3286 vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
3287 int maxevents, double wait_for_time)
3289 vcl_worker_t *wrk = vcl_worker_get_current ();
3290 vcl_session_t *vep_session;
3294 if (PREDICT_FALSE (maxevents <= 0))
3296 VDBG (0, "ERROR: Invalid maxevents (%d)!", maxevents);
3297 return VPPCOM_EINVAL;
3300 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
3302 return VPPCOM_EBADFD;
3304 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
3306 VDBG (0, "ERROR: vep_idx (%u) is not a vep!", vep_handle);
3307 return VPPCOM_EINVAL;
3310 if (vec_len (wrk->unhandled_evts_vector))
3312 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
3314 vcl_epoll_wait_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i],
3316 if (n_evts == maxevents)
3318 vec_delete (wrk->unhandled_evts_vector, i + 1, 0);
3322 vec_reset_length (wrk->unhandled_evts_vector);
3325 if (PREDICT_FALSE (wrk->ep_lt_current != VCL_INVALID_SESSION_INDEX))
3326 vcl_epoll_wait_handle_lt (wrk, events, maxevents, &n_evts);
3328 /* Request to only drain unhandled */
3329 if ((int) wait_for_time == -2)
3333 if (vcm->cfg.use_mq_eventfd)
3334 n_evts = vppcom_epoll_wait_eventfd (wrk, events, maxevents, n_evts,
3337 n_evts = vppcom_epoll_wait_condvar (wrk, events, maxevents, n_evts,
3344 vppcom_session_attr (uint32_t session_handle, uint32_t op,
3345 void *buffer, uint32_t * buflen)
3347 vcl_worker_t *wrk = vcl_worker_get_current ();
3348 u32 *flags = buffer;
3349 vppcom_endpt_t *ep = buffer;
3350 transport_endpt_attr_t tea;
3351 vcl_session_t *session;
3354 session = vcl_session_get_w_handle (wrk, session_handle);
3356 return VPPCOM_EBADFD;
3360 case VPPCOM_ATTR_GET_NREAD:
3361 rv = vcl_session_read_ready (session);
3362 VDBG (2, "VPPCOM_ATTR_GET_NREAD: sh %u, nread = %d", session_handle,
3366 case VPPCOM_ATTR_GET_NWRITE:
3367 rv = vcl_session_write_ready (session);
3368 VDBG (2, "VPPCOM_ATTR_GET_NWRITE: sh %u, nwrite = %d", session_handle,
3372 case VPPCOM_ATTR_GET_FLAGS:
3373 if (PREDICT_TRUE (buffer && buflen && (*buflen >= sizeof (*flags))))
3377 (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK) ?
3379 *buflen = sizeof (*flags);
3380 VDBG (2, "VPPCOM_ATTR_GET_FLAGS: sh %u, flags = 0x%08x, "
3381 "is_nonblocking = %u", session_handle, *flags,
3382 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3388 case VPPCOM_ATTR_SET_FLAGS:
3389 if (PREDICT_TRUE (buffer && buflen && (*buflen == sizeof (*flags))))
3391 if (*flags & O_NONBLOCK)
3392 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
3394 vcl_session_clear_attr (session, VCL_SESS_ATTR_NONBLOCK);
3396 VDBG (2, "VPPCOM_ATTR_SET_FLAGS: sh %u, flags = 0x%08x,"
3397 " is_nonblocking = %u", session_handle, *flags,
3398 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3404 case VPPCOM_ATTR_GET_PEER_ADDR:
3405 if (PREDICT_TRUE (buffer && buflen &&
3406 (*buflen >= sizeof (*ep)) && ep->ip))
3408 ep->is_ip4 = session->transport.is_ip4;
3409 ep->port = session->transport.rmt_port;
3410 if (session->transport.is_ip4)
3411 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
3412 sizeof (ip4_address_t));
3414 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
3415 sizeof (ip6_address_t));
3416 *buflen = sizeof (*ep);
3418 "VPPCOM_ATTR_GET_PEER_ADDR: sh %u, is_ip4 = %u, "
3419 "addr = %U, port %u",
3420 session_handle, ep->is_ip4, vcl_format_ip46_address,
3421 &session->transport.rmt_ip,
3422 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3423 clib_net_to_host_u16 (ep->port));
3429 case VPPCOM_ATTR_GET_LCL_ADDR:
3430 if (PREDICT_TRUE (buffer && buflen &&
3431 (*buflen >= sizeof (*ep)) && ep->ip))
3433 ep->is_ip4 = session->transport.is_ip4;
3434 ep->port = session->transport.lcl_port;
3435 if (session->transport.is_ip4)
3436 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip4,
3437 sizeof (ip4_address_t));
3439 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip6,
3440 sizeof (ip6_address_t));
3441 *buflen = sizeof (*ep);
3443 "VPPCOM_ATTR_GET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3445 session_handle, ep->is_ip4, vcl_format_ip46_address,
3446 &session->transport.lcl_ip,
3447 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3448 clib_net_to_host_u16 (ep->port));
3454 case VPPCOM_ATTR_SET_LCL_ADDR:
3455 if (PREDICT_TRUE (buffer && buflen &&
3456 (*buflen >= sizeof (*ep)) && ep->ip))
3458 session->transport.is_ip4 = ep->is_ip4;
3459 session->transport.lcl_port = ep->port;
3460 vcl_ip_copy_from_ep (&session->transport.lcl_ip, ep);
3461 *buflen = sizeof (*ep);
3463 "VPPCOM_ATTR_SET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3465 session_handle, ep->is_ip4, vcl_format_ip46_address,
3466 &session->transport.lcl_ip,
3467 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3468 clib_net_to_host_u16 (ep->port));
3474 case VPPCOM_ATTR_GET_LIBC_EPFD:
3475 rv = session->libc_epfd;
3476 VDBG (2, "VPPCOM_ATTR_GET_LIBC_EPFD: libc_epfd %d", rv);
3479 case VPPCOM_ATTR_SET_LIBC_EPFD:
3480 if (PREDICT_TRUE (buffer && buflen &&
3481 (*buflen == sizeof (session->libc_epfd))))
3483 session->libc_epfd = *(int *) buffer;
3484 *buflen = sizeof (session->libc_epfd);
3486 VDBG (2, "VPPCOM_ATTR_SET_LIBC_EPFD: libc_epfd %d, buflen %d",
3487 session->libc_epfd, *buflen);
3493 case VPPCOM_ATTR_GET_PROTOCOL:
3494 if (buffer && buflen && (*buflen >= sizeof (int)))
3496 *(int *) buffer = session->session_type;
3497 *buflen = sizeof (int);
3499 VDBG (2, "VPPCOM_ATTR_GET_PROTOCOL: %d (%s), buflen %d",
3500 *(int *) buffer, *(int *) buffer ? "UDP" : "TCP", *buflen);
3506 case VPPCOM_ATTR_GET_LISTEN:
3507 if (buffer && buflen && (*buflen >= sizeof (int)))
3509 *(int *) buffer = vcl_session_has_attr (session,
3510 VCL_SESS_ATTR_LISTEN);
3511 *buflen = sizeof (int);
3513 VDBG (2, "VPPCOM_ATTR_GET_LISTEN: %d, buflen %d", *(int *) buffer,
3520 case VPPCOM_ATTR_GET_ERROR:
3521 if (buffer && buflen && (*buflen >= sizeof (int)))
3523 *(int *) buffer = 0;
3524 *buflen = sizeof (int);
3526 VDBG (2, "VPPCOM_ATTR_GET_ERROR: %d, buflen %d, #VPP-TBD#",
3527 *(int *) buffer, *buflen);
3533 case VPPCOM_ATTR_GET_TX_FIFO_LEN:
3534 if (buffer && buflen && (*buflen >= sizeof (u32)))
3538 *(size_t *) buffer = (session->sndbuf_size ? session->sndbuf_size :
3540 svm_fifo_size (session->tx_fifo) :
3541 vcm->cfg.tx_fifo_size);
3542 *buflen = sizeof (u32);
3544 VDBG (2, "VPPCOM_ATTR_GET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3545 " #VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer,
3552 case VPPCOM_ATTR_SET_DSCP:
3553 if (buffer && buflen && (*buflen >= sizeof (u8)))
3555 session->dscp = *(u8 *) buffer;
3557 VDBG (2, "VPPCOM_ATTR_SET_DSCP: %u (0x%x), buflen %d,",
3558 *(u8 *) buffer, *(u8 *) buffer, *buflen);
3564 case VPPCOM_ATTR_SET_TX_FIFO_LEN:
3565 if (buffer && buflen && (*buflen == sizeof (u32)))
3568 session->sndbuf_size = *(u32 *) buffer;
3569 VDBG (2, "VPPCOM_ATTR_SET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3570 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3577 case VPPCOM_ATTR_GET_RX_FIFO_LEN:
3578 if (buffer && buflen && (*buflen >= sizeof (u32)))
3582 *(size_t *) buffer = (session->rcvbuf_size ? session->rcvbuf_size :
3584 svm_fifo_size (session->rx_fifo) :
3585 vcm->cfg.rx_fifo_size);
3586 *buflen = sizeof (u32);
3588 VDBG (2, "VPPCOM_ATTR_GET_RX_FIFO_LEN: %u (0x%x), buflen %d, "
3589 "#VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer, *buflen);
3595 case VPPCOM_ATTR_SET_RX_FIFO_LEN:
3596 if (buffer && buflen && (*buflen == sizeof (u32)))
3599 session->rcvbuf_size = *(u32 *) buffer;
3600 VDBG (2, "VPPCOM_ATTR_SET_RX_FIFO_LEN: %u (0x%x), buflen %d,"
3601 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3608 case VPPCOM_ATTR_GET_REUSEADDR:
3609 if (buffer && buflen && (*buflen >= sizeof (int)))
3612 *(int *) buffer = vcl_session_has_attr (session,
3613 VCL_SESS_ATTR_REUSEADDR);
3614 *buflen = sizeof (int);
3616 VDBG (2, "VPPCOM_ATTR_GET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3617 *(int *) buffer, *buflen);
3623 case VPPCOM_ATTR_SET_REUSEADDR:
3624 if (buffer && buflen && (*buflen == sizeof (int)) &&
3625 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3628 if (*(int *) buffer)
3629 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEADDR);
3631 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEADDR);
3633 VDBG (2, "VPPCOM_ATTR_SET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3634 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEADDR),
3641 case VPPCOM_ATTR_GET_REUSEPORT:
3642 if (buffer && buflen && (*buflen >= sizeof (int)))
3645 *(int *) buffer = vcl_session_has_attr (session,
3646 VCL_SESS_ATTR_REUSEPORT);
3647 *buflen = sizeof (int);
3649 VDBG (2, "VPPCOM_ATTR_GET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3650 *(int *) buffer, *buflen);
3656 case VPPCOM_ATTR_SET_REUSEPORT:
3657 if (buffer && buflen && (*buflen == sizeof (int)) &&
3658 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3661 if (*(int *) buffer)
3662 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEPORT);
3664 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEPORT);
3666 VDBG (2, "VPPCOM_ATTR_SET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3667 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEPORT),
3674 case VPPCOM_ATTR_GET_BROADCAST:
3675 if (buffer && buflen && (*buflen >= sizeof (int)))
3678 *(int *) buffer = vcl_session_has_attr (session,
3679 VCL_SESS_ATTR_BROADCAST);
3680 *buflen = sizeof (int);
3682 VDBG (2, "VPPCOM_ATTR_GET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3683 *(int *) buffer, *buflen);
3689 case VPPCOM_ATTR_SET_BROADCAST:
3690 if (buffer && buflen && (*buflen == sizeof (int)))
3693 if (*(int *) buffer)
3694 vcl_session_set_attr (session, VCL_SESS_ATTR_BROADCAST);
3696 vcl_session_clear_attr (session, VCL_SESS_ATTR_BROADCAST);
3698 VDBG (2, "VPPCOM_ATTR_SET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3699 vcl_session_has_attr (session, VCL_SESS_ATTR_BROADCAST),
3706 case VPPCOM_ATTR_GET_V6ONLY:
3707 if (buffer && buflen && (*buflen >= sizeof (int)))
3710 *(int *) buffer = vcl_session_has_attr (session,
3711 VCL_SESS_ATTR_V6ONLY);
3712 *buflen = sizeof (int);
3714 VDBG (2, "VPPCOM_ATTR_GET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3715 *(int *) buffer, *buflen);
3721 case VPPCOM_ATTR_SET_V6ONLY:
3722 if (buffer && buflen && (*buflen == sizeof (int)))
3725 if (*(int *) buffer)
3726 vcl_session_set_attr (session, VCL_SESS_ATTR_V6ONLY);
3728 vcl_session_clear_attr (session, VCL_SESS_ATTR_V6ONLY);
3730 VDBG (2, "VPPCOM_ATTR_SET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3731 vcl_session_has_attr (session, VCL_SESS_ATTR_V6ONLY),
3738 case VPPCOM_ATTR_GET_KEEPALIVE:
3739 if (buffer && buflen && (*buflen >= sizeof (int)))
3742 *(int *) buffer = vcl_session_has_attr (session,
3743 VCL_SESS_ATTR_KEEPALIVE);
3744 *buflen = sizeof (int);
3746 VDBG (2, "VPPCOM_ATTR_GET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3747 *(int *) buffer, *buflen);
3753 case VPPCOM_ATTR_SET_KEEPALIVE:
3754 if (buffer && buflen && (*buflen == sizeof (int)))
3757 if (*(int *) buffer)
3758 vcl_session_set_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3760 vcl_session_clear_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3762 VDBG (2, "VPPCOM_ATTR_SET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3763 vcl_session_has_attr (session, VCL_SESS_ATTR_KEEPALIVE),
3770 case VPPCOM_ATTR_GET_TCP_NODELAY:
3771 if (buffer && buflen && (*buflen >= sizeof (int)))
3774 *(int *) buffer = vcl_session_has_attr (session,
3775 VCL_SESS_ATTR_TCP_NODELAY);
3776 *buflen = sizeof (int);
3778 VDBG (2, "VPPCOM_ATTR_GET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3779 *(int *) buffer, *buflen);
3785 case VPPCOM_ATTR_SET_TCP_NODELAY:
3786 if (buffer && buflen && (*buflen == sizeof (int)))
3789 if (*(int *) buffer)
3790 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3792 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3794 VDBG (2, "VPPCOM_ATTR_SET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3795 vcl_session_has_attr (session, VCL_SESS_ATTR_TCP_NODELAY),
3802 case VPPCOM_ATTR_GET_TCP_KEEPIDLE:
3803 if (buffer && buflen && (*buflen >= sizeof (int)))
3806 *(int *) buffer = vcl_session_has_attr (session,
3807 VCL_SESS_ATTR_TCP_KEEPIDLE);
3808 *buflen = sizeof (int);
3810 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3811 *(int *) buffer, *buflen);
3817 case VPPCOM_ATTR_SET_TCP_KEEPIDLE:
3818 if (buffer && buflen && (*buflen == sizeof (int)))
3821 if (*(int *) buffer)
3822 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3824 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3826 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3827 vcl_session_has_attr (session,
3828 VCL_SESS_ATTR_TCP_KEEPIDLE), *buflen);
3834 case VPPCOM_ATTR_GET_TCP_KEEPINTVL:
3835 if (buffer && buflen && (*buflen >= sizeof (int)))
3838 *(int *) buffer = vcl_session_has_attr (session,
3839 VCL_SESS_ATTR_TCP_KEEPINTVL);
3840 *buflen = sizeof (int);
3842 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3843 *(int *) buffer, *buflen);
3849 case VPPCOM_ATTR_SET_TCP_KEEPINTVL:
3850 if (buffer && buflen && (*buflen == sizeof (int)))
3853 if (*(int *) buffer)
3854 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3856 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3858 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3859 vcl_session_has_attr (session,
3860 VCL_SESS_ATTR_TCP_KEEPINTVL), *buflen);
3866 case VPPCOM_ATTR_GET_TCP_USER_MSS:
3867 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
3873 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3874 tea.mss = *(u32 *) buffer;
3875 if (vcl_session_transport_attr (wrk, session, 1 /* is_get */, &tea))
3876 rv = VPPCOM_ENOPROTOOPT;
3880 *(u32 *) buffer = tea.mss;
3881 *buflen = sizeof (int);
3884 VDBG (2, "VPPCOM_ATTR_GET_TCP_USER_MSS: %d, buflen %d", *(int *) buffer,
3888 case VPPCOM_ATTR_SET_TCP_USER_MSS:
3889 if (!(buffer && buflen && (*buflen == sizeof (u32))))
3895 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3896 tea.mss = *(u32 *) buffer;
3897 if (vcl_session_transport_attr (wrk, session, 0 /* is_get */, &tea))
3898 rv = VPPCOM_ENOPROTOOPT;
3900 VDBG (2, "VPPCOM_ATTR_SET_TCP_USER_MSS: %u, buflen %d", tea.mss,
3904 case VPPCOM_ATTR_SET_CONNECTED:
3905 session->flags |= VCL_SESSION_F_CONNECTED;
3908 case VPPCOM_ATTR_SET_CKPAIR:
3909 if (!(buffer && buflen && (*buflen == sizeof (int))) ||
3910 !vcl_session_has_crypto (session))
3915 if (!session->ext_config)
3917 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_CRYPTO,
3918 sizeof (transport_endpt_ext_cfg_t));
3920 else if (session->ext_config->type != TRANSPORT_ENDPT_EXT_CFG_CRYPTO)
3926 session->ext_config->crypto.ckpair_index = *(uint32_t *) buffer;
3929 case VPPCOM_ATTR_SET_VRF:
3930 if (!(buffer && buflen && (*buflen == sizeof (u32))))
3935 session->vrf = *(u32 *) buffer;
3938 case VPPCOM_ATTR_GET_VRF:
3939 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
3944 *(u32 *) buffer = session->vrf;
3945 *buflen = sizeof (u32);
3948 case VPPCOM_ATTR_GET_DOMAIN:
3949 if (!(buffer && buflen && (*buflen >= sizeof (int))))
3955 if (session->transport.is_ip4)
3956 *(int *) buffer = AF_INET;
3958 *(int *) buffer = AF_INET6;
3959 *buflen = sizeof (int);
3961 VDBG (2, "VPPCOM_ATTR_GET_DOMAIN: %d, buflen %u", *(int *) buffer,
3965 case VPPCOM_ATTR_SET_ENDPT_EXT_CFG:
3966 if (!(buffer && buflen && (*buflen > 0)))
3971 if (session->ext_config)
3976 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_NONE,
3977 *buflen + sizeof (u32));
3978 clib_memcpy (session->ext_config->data, buffer, *buflen);
3979 session->ext_config->len = *buflen;
3991 vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
3992 uint32_t buflen, int flags, vppcom_endpt_t * ep)
3994 vcl_worker_t *wrk = vcl_worker_get_current ();
3995 vcl_session_t *session;
3999 rv = vppcom_session_read (session_handle, buffer, buflen);
4000 else if (flags & MSG_PEEK)
4001 rv = vppcom_session_peek (session_handle, buffer, buflen);
4004 VDBG (0, "Unsupport flags for recvfrom %d", flags);
4005 return VPPCOM_EAFNOSUPPORT;
4010 session = vcl_session_get_w_handle (wrk, session_handle);
4011 if (session->transport.is_ip4)
4012 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
4013 sizeof (ip4_address_t));
4015 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
4016 sizeof (ip6_address_t));
4017 ep->is_ip4 = session->transport.is_ip4;
4018 ep->port = session->transport.rmt_port;
4025 vppcom_session_sendto (uint32_t session_handle, void *buffer,
4026 uint32_t buflen, int flags, vppcom_endpt_t * ep)
4028 vcl_worker_t *wrk = vcl_worker_get_current ();
4031 s = vcl_session_get_w_handle (wrk, session_handle);
4032 if (PREDICT_FALSE (!s))
4033 return VPPCOM_EBADFD;
4037 if (!vcl_session_is_cl (s))
4038 return VPPCOM_EINVAL;
4040 s->transport.is_ip4 = ep->is_ip4;
4041 s->transport.rmt_port = ep->port;
4042 vcl_ip_copy_from_ep (&s->transport.rmt_ip, ep);
4044 /* Session not connected/bound in vpp. Create it by 'connecting' it */
4045 if (PREDICT_FALSE (s->session_state == VCL_STATE_CLOSED))
4047 u32 session_index = s->session_index;
4048 f64 timeout = vcm->cfg.session_timeout;
4051 vcl_send_session_connect (wrk, s);
4052 rv = vppcom_wait_for_session_state_change (session_index,
4057 s = vcl_session_get (wrk, session_index);
4063 // TBD check the flags and do the right thing
4064 VDBG (2, "handling flags 0x%u (%d) not implemented yet.", flags, flags);
4067 return (vppcom_session_write_inline (wrk, s, buffer, buflen, 1,
4068 s->is_dgram ? 1 : 0));
4072 vppcom_poll (vcl_poll_t * vp, uint32_t n_sids, double wait_for_time)
4074 vcl_worker_t *wrk = vcl_worker_get_current ();
4075 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
4076 u32 i, keep_trying = 1;
4077 svm_msg_q_msg_t msg;
4081 VDBG (3, "vp %p, nsids %u, wait_for_time %f", vp, n_sids, wait_for_time);
4084 return VPPCOM_EFAULT;
4088 vcl_session_t *session;
4090 /* Dequeue all events and drop all unhandled io events */
4091 while (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0) == 0)
4093 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
4094 vcl_handle_mq_event (wrk, e);
4095 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
4097 vec_reset_length (wrk->unhandled_evts_vector);
4099 for (i = 0; i < n_sids; i++)
4101 session = vcl_session_get (wrk, vp[i].sh);
4104 vp[i].revents = POLLHUP;
4111 if (POLLIN & vp[i].events)
4113 rv = vcl_session_read_ready (session);
4116 vp[i].revents |= POLLIN;
4123 case VPPCOM_ECONNRESET:
4124 vp[i].revents = POLLHUP;
4128 vp[i].revents = POLLERR;
4135 if (POLLOUT & vp[i].events)
4137 rv = vcl_session_write_ready (session);
4140 vp[i].revents |= POLLOUT;
4147 case VPPCOM_ECONNRESET:
4148 vp[i].revents = POLLHUP;
4152 vp[i].revents = POLLERR;
4159 if (0) // Note "done:" label used by VCL_SESSION_LOCK_AND_GET()
4161 vp[i].revents = POLLNVAL;
4165 if (wait_for_time != -1)
4166 keep_trying = (clib_time_now (&wrk->clib_time) <= timeout) ? 1 : 0;
4168 while ((num_ev == 0) && keep_trying);
4174 vppcom_mq_epoll_fd (void)
4176 vcl_worker_t *wrk = vcl_worker_get_current ();
4177 return wrk->mqs_epfd;
4181 vppcom_session_index (vcl_session_handle_t session_handle)
4183 return session_handle & 0xFFFFFF;
4187 vppcom_session_worker (vcl_session_handle_t session_handle)
4189 return session_handle >> 24;
4193 vppcom_worker_register (void)
4195 if (!vcl_worker_alloc_and_init ())
4196 return VPPCOM_EEXIST;
4198 if (vcl_worker_register_with_vpp ())
4199 return VPPCOM_EEXIST;
4205 vppcom_worker_unregister (void)
4207 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
4208 vcl_set_worker_index (~0);
4212 vppcom_worker_index_set (int index)
4214 vcl_set_worker_index (index);
4218 vppcom_worker_index (void)
4220 return vcl_get_worker_index ();
4224 vppcom_worker_mqs_epfd (void)
4226 vcl_worker_t *wrk = vcl_worker_get_current ();
4227 if (!vcm->cfg.use_mq_eventfd)
4229 return wrk->mqs_epfd;
4233 vppcom_session_is_connectable_listener (uint32_t session_handle)
4235 vcl_session_t *session;
4236 vcl_worker_t *wrk = vcl_worker_get_current ();
4237 session = vcl_session_get_w_handle (wrk, session_handle);
4239 return VPPCOM_EBADFD;
4240 return vcl_session_is_connectable_listener (wrk, session);
4244 vppcom_session_listener (uint32_t session_handle)
4246 vcl_worker_t *wrk = vcl_worker_get_current ();
4247 vcl_session_t *listen_session, *session;
4248 session = vcl_session_get_w_handle (wrk, session_handle);
4250 return VPPCOM_EBADFD;
4251 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
4252 return VPPCOM_EBADFD;
4253 listen_session = vcl_session_get_w_handle (wrk, session->listener_index);
4254 if (!listen_session)
4255 return VPPCOM_EBADFD;
4256 return vcl_session_handle (listen_session);
4260 vppcom_session_n_accepted (uint32_t session_handle)
4262 vcl_worker_t *wrk = vcl_worker_get_current ();
4263 vcl_session_t *session = vcl_session_get_w_handle (wrk, session_handle);
4265 return VPPCOM_EBADFD;
4266 return session->n_accepted_sessions;
4270 vppcom_proto_str (vppcom_proto_t proto)
4272 char const *proto_str;
4276 case VPPCOM_PROTO_TCP:
4279 case VPPCOM_PROTO_UDP:
4282 case VPPCOM_PROTO_TLS:
4285 case VPPCOM_PROTO_QUIC:
4288 case VPPCOM_PROTO_DTLS:
4291 case VPPCOM_PROTO_SRTP:
4295 proto_str = "UNKNOWN";
4302 vppcom_retval_str (int retval)
4313 st = "VPPCOM_EAGAIN";
4317 st = "VPPCOM_EFAULT";
4321 st = "VPPCOM_ENOMEM";
4325 st = "VPPCOM_EINVAL";
4329 st = "VPPCOM_EBADFD";
4332 case VPPCOM_EAFNOSUPPORT:
4333 st = "VPPCOM_EAFNOSUPPORT";
4336 case VPPCOM_ECONNABORTED:
4337 st = "VPPCOM_ECONNABORTED";
4340 case VPPCOM_ECONNRESET:
4341 st = "VPPCOM_ECONNRESET";
4344 case VPPCOM_ENOTCONN:
4345 st = "VPPCOM_ENOTCONN";
4348 case VPPCOM_ECONNREFUSED:
4349 st = "VPPCOM_ECONNREFUSED";
4352 case VPPCOM_ETIMEDOUT:
4353 st = "VPPCOM_ETIMEDOUT";
4357 st = "UNKNOWN_STATE";
4365 vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
4367 if (vcm->cfg.vpp_app_socket_api)
4368 return vcl_sapi_add_cert_key_pair (ckpair);
4370 return vcl_bapi_add_cert_key_pair (ckpair);
4374 vppcom_del_cert_key_pair (uint32_t ckpair_index)
4376 if (vcm->cfg.vpp_app_socket_api)
4377 return vcl_sapi_del_cert_key_pair (ckpair_index);
4379 return vcl_bapi_del_cert_key_pair (ckpair_index);
4383 * fd.io coding-style-patch-verification: ON
4386 * eval: (c-set-style "gnu")