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);
41 vppcom_session_state_str (vcl_session_state_t state)
47 case VCL_STATE_CLOSED:
50 case VCL_STATE_LISTEN:
56 case VCL_STATE_VPP_CLOSING:
57 st = "STATE_VPP_CLOSING";
59 case VCL_STATE_DISCONNECT:
60 st = "STATE_DISCONNECT";
62 case VCL_STATE_DETACHED:
63 st = "STATE_DETACHED";
65 case VCL_STATE_UPDATED:
68 case VCL_STATE_LISTEN_NO_MQ:
69 st = "STATE_LISTEN_NO_MQ";
80 format_ip4_address (u8 * s, va_list * args)
82 u8 *a = va_arg (*args, u8 *);
83 return format (s, "%d.%d.%d.%d", a[0], a[1], a[2], a[3]);
87 format_ip6_address (u8 * s, va_list * args)
89 ip6_address_t *a = va_arg (*args, ip6_address_t *);
90 u32 i, i_max_n_zero, max_n_zeros, i_first_zero, n_zeros, last_double_colon;
92 i_max_n_zero = ARRAY_LEN (a->as_u16);
94 i_first_zero = i_max_n_zero;
96 for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
98 u32 is_zero = a->as_u16[i] == 0;
99 if (is_zero && i_first_zero >= ARRAY_LEN (a->as_u16))
105 if ((!is_zero && n_zeros > max_n_zeros)
106 || (i + 1 >= ARRAY_LEN (a->as_u16) && n_zeros > max_n_zeros))
108 i_max_n_zero = i_first_zero;
109 max_n_zeros = n_zeros;
110 i_first_zero = ARRAY_LEN (a->as_u16);
115 last_double_colon = 0;
116 for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
118 if (i == i_max_n_zero && max_n_zeros > 1)
120 s = format (s, "::");
121 i += max_n_zeros - 1;
122 last_double_colon = 1;
126 s = format (s, "%s%x",
127 (last_double_colon || i == 0) ? "" : ":",
128 clib_net_to_host_u16 (a->as_u16[i]));
129 last_double_colon = 0;
136 /* Format an IP46 address. */
138 format_ip46_address (u8 * s, va_list * args)
140 ip46_address_t *ip46 = va_arg (*args, ip46_address_t *);
141 ip46_type_t type = va_arg (*args, ip46_type_t);
147 is_ip4 = ip46_address_is_ip4 (ip46);
158 format (s, "%U", format_ip4_address, &ip46->ip4) :
159 format (s, "%U", format_ip6_address, &ip46->ip6);
163 * VPPCOM Utility Functions
167 vcl_msg_add_ext_config (vcl_session_t *s, uword *offset)
171 c = vcl_segment_alloc_chunk (vcl_vpp_worker_segment_handle (0),
172 0 /* one slice only */, s->ext_config->len,
175 clib_memcpy_fast (c->data, s->ext_config, s->ext_config->len);
179 vcl_send_session_listen (vcl_worker_t * wrk, vcl_session_t * s)
181 app_session_evt_t _app_evt, *app_evt = &_app_evt;
182 session_listen_msg_t *mp;
185 mq = vcl_worker_ctrl_mq (wrk);
186 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_LISTEN);
187 mp = (session_listen_msg_t *) app_evt->evt->data;
188 memset (mp, 0, sizeof (*mp));
189 mp->client_index = wrk->api_client_handle;
190 mp->context = s->session_index;
191 mp->wrk_index = wrk->vpp_wrk_index;
192 mp->is_ip4 = s->transport.is_ip4;
193 clib_memcpy_fast (&mp->ip, &s->transport.lcl_ip, sizeof (mp->ip));
194 mp->port = s->transport.lcl_port;
195 mp->proto = s->session_type;
197 if (s->flags & VCL_SESSION_F_CONNECTED)
198 mp->flags = TRANSPORT_CFG_F_CONNECTED;
200 vcl_msg_add_ext_config (s, &mp->ext_config);
201 app_send_ctrl_evt_to_vpp (mq, app_evt);
204 clib_mem_free (s->ext_config);
210 vcl_send_session_connect (vcl_worker_t * wrk, vcl_session_t * s)
212 app_session_evt_t _app_evt, *app_evt = &_app_evt;
213 session_connect_msg_t *mp;
216 mq = vcl_worker_ctrl_mq (wrk);
217 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_CONNECT);
218 mp = (session_connect_msg_t *) app_evt->evt->data;
219 memset (mp, 0, sizeof (*mp));
220 mp->client_index = wrk->api_client_handle;
221 mp->context = s->session_index;
223 mp->wrk_index = wrk->vpp_wrk_index;
224 mp->is_ip4 = s->transport.is_ip4;
225 mp->parent_handle = s->parent_handle;
226 clib_memcpy_fast (&mp->ip, &s->transport.rmt_ip, sizeof (mp->ip));
227 clib_memcpy_fast (&mp->lcl_ip, &s->transport.lcl_ip, sizeof (mp->lcl_ip));
228 mp->port = s->transport.rmt_port;
229 mp->lcl_port = s->transport.lcl_port;
230 mp->proto = s->session_type;
232 if (s->flags & VCL_SESSION_F_CONNECTED)
233 mp->flags |= TRANSPORT_CFG_F_CONNECTED;
235 vcl_msg_add_ext_config (s, &mp->ext_config);
236 app_send_ctrl_evt_to_vpp (mq, app_evt);
240 clib_mem_free (s->ext_config);
246 vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s)
248 app_session_evt_t _app_evt, *app_evt = &_app_evt;
249 session_unlisten_msg_t *mp;
252 mq = vcl_worker_ctrl_mq (wrk);
253 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_UNLISTEN);
254 mp = (session_unlisten_msg_t *) app_evt->evt->data;
255 memset (mp, 0, sizeof (*mp));
256 mp->client_index = wrk->api_client_handle;
257 mp->wrk_index = wrk->vpp_wrk_index;
258 mp->handle = s->vpp_handle;
259 mp->context = wrk->wrk_index;
260 app_send_ctrl_evt_to_vpp (mq, app_evt);
264 vcl_send_session_shutdown (vcl_worker_t *wrk, vcl_session_t *s)
266 app_session_evt_t _app_evt, *app_evt = &_app_evt;
267 session_shutdown_msg_t *mp;
270 /* Send to thread that owns the session */
272 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_SHUTDOWN);
273 mp = (session_shutdown_msg_t *) app_evt->evt->data;
274 memset (mp, 0, sizeof (*mp));
275 mp->client_index = wrk->api_client_handle;
276 mp->handle = s->vpp_handle;
277 app_send_ctrl_evt_to_vpp (mq, app_evt);
281 vcl_send_session_disconnect (vcl_worker_t * wrk, vcl_session_t * s)
283 app_session_evt_t _app_evt, *app_evt = &_app_evt;
284 session_disconnect_msg_t *mp;
287 /* Send to thread that owns the session */
289 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_DISCONNECT);
290 mp = (session_disconnect_msg_t *) app_evt->evt->data;
291 memset (mp, 0, sizeof (*mp));
292 mp->client_index = wrk->api_client_handle;
293 mp->handle = s->vpp_handle;
294 app_send_ctrl_evt_to_vpp (mq, app_evt);
298 vcl_send_app_detach (vcl_worker_t * wrk)
300 app_session_evt_t _app_evt, *app_evt = &_app_evt;
301 session_app_detach_msg_t *mp;
304 mq = vcl_worker_ctrl_mq (wrk);
305 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_DETACH);
306 mp = (session_app_detach_msg_t *) app_evt->evt->data;
307 memset (mp, 0, sizeof (*mp));
308 mp->client_index = wrk->api_client_handle;
309 app_send_ctrl_evt_to_vpp (mq, app_evt);
313 vcl_send_session_accepted_reply (svm_msg_q_t * mq, u32 context,
314 session_handle_t handle, int retval)
316 app_session_evt_t _app_evt, *app_evt = &_app_evt;
317 session_accepted_reply_msg_t *rmp;
318 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_ACCEPTED_REPLY);
319 rmp = (session_accepted_reply_msg_t *) app_evt->evt->data;
320 rmp->handle = handle;
321 rmp->context = context;
322 rmp->retval = retval;
323 app_send_ctrl_evt_to_vpp (mq, app_evt);
327 vcl_send_session_disconnected_reply (vcl_worker_t * wrk, vcl_session_t * s,
330 app_session_evt_t _app_evt, *app_evt = &_app_evt;
331 session_disconnected_reply_msg_t *rmp;
332 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
333 SESSION_CTRL_EVT_DISCONNECTED_REPLY);
334 rmp = (session_disconnected_reply_msg_t *) app_evt->evt->data;
335 rmp->handle = s->vpp_handle;
336 rmp->context = wrk->api_client_handle;
337 rmp->retval = retval;
338 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
342 vcl_send_session_reset_reply (vcl_worker_t * wrk, vcl_session_t * s,
345 app_session_evt_t _app_evt, *app_evt = &_app_evt;
346 session_reset_reply_msg_t *rmp;
347 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
348 SESSION_CTRL_EVT_RESET_REPLY);
349 rmp = (session_reset_reply_msg_t *) app_evt->evt->data;
350 rmp->handle = s->vpp_handle;
351 rmp->context = wrk->api_client_handle;
352 rmp->retval = retval;
353 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
357 vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
360 app_session_evt_t _app_evt, *app_evt = &_app_evt;
361 session_worker_update_msg_t *mp;
363 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
364 SESSION_CTRL_EVT_WORKER_UPDATE);
365 mp = (session_worker_update_msg_t *) app_evt->evt->data;
366 mp->client_index = wrk->api_client_handle;
367 mp->handle = s->vpp_handle;
368 mp->req_wrk_index = wrk->vpp_wrk_index;
369 mp->wrk_index = wrk_index;
370 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
374 vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len)
376 app_session_evt_t _app_evt, *app_evt = &_app_evt;
377 session_app_wrk_rpc_msg_t *mp;
378 vcl_worker_t *dst_wrk, *wrk;
382 if (data_len > sizeof (mp->data))
385 clib_spinlock_lock (&vcm->workers_lock);
387 dst_wrk = vcl_worker_get_if_valid (dst_wrk_index);
391 wrk = vcl_worker_get_current ();
392 mq = vcl_worker_ctrl_mq (wrk);
393 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_WRK_RPC);
394 mp = (session_app_wrk_rpc_msg_t *) app_evt->evt->data;
395 mp->client_index = wrk->api_client_handle;
396 mp->wrk_index = dst_wrk->vpp_wrk_index;
397 clib_memcpy (mp->data, data, data_len);
398 app_send_ctrl_evt_to_vpp (mq, app_evt);
402 clib_spinlock_unlock (&vcm->workers_lock);
407 vcl_session_transport_attr (vcl_worker_t *wrk, vcl_session_t *s, u8 is_get,
408 transport_endpt_attr_t *attr)
410 app_session_evt_t _app_evt, *app_evt = &_app_evt;
411 session_transport_attr_msg_t *mp;
415 ASSERT (!wrk->session_attr_op);
416 wrk->session_attr_op = 1;
417 wrk->session_attr_op_rv = -1;
420 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_TRANSPORT_ATTR);
421 mp = (session_transport_attr_msg_t *) app_evt->evt->data;
422 memset (mp, 0, sizeof (*mp));
423 mp->client_index = wrk->api_client_handle;
424 mp->handle = s->vpp_handle;
427 app_send_ctrl_evt_to_vpp (mq, app_evt);
429 timeout = clib_time_now (&wrk->clib_time) + 1;
431 while (wrk->session_attr_op && clib_time_now (&wrk->clib_time) < timeout)
432 vcl_flush_mq_events ();
434 if (!wrk->session_attr_op_rv && is_get)
435 *attr = wrk->session_attr_rv;
437 wrk->session_attr_op = 0;
439 return wrk->session_attr_op_rv;
443 vcl_session_accepted_handler (vcl_worker_t * wrk, session_accepted_msg_t * mp,
446 vcl_session_t *session, *listen_session;
449 session = vcl_session_alloc (wrk);
451 listen_session = vcl_session_get (wrk, ls_index);
452 if (listen_session->vpp_handle != mp->listener_handle)
454 VDBG (0, "ERROR: listener handle %lu does not match session %u",
455 mp->listener_handle, ls_index);
459 if (vcl_segment_attach_session (
460 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
461 mp->vpp_event_queue_address, mp->mq_index, 0, session))
463 VDBG (0, "failed to attach fifos for %u", session->session_index);
467 session->vpp_handle = mp->handle;
468 session->session_state = VCL_STATE_READY;
469 session->transport.rmt_port = mp->rmt.port;
470 session->transport.is_ip4 = mp->rmt.is_ip4;
471 clib_memcpy_fast (&session->transport.rmt_ip, &mp->rmt.ip,
472 sizeof (ip46_address_t));
474 vcl_session_table_add_vpp_handle (wrk, mp->handle, session->session_index);
475 session->transport.lcl_port = mp->lcl.port;
476 session->transport.lcl_ip = mp->lcl.ip;
477 session->session_type = listen_session->session_type;
478 session->is_dgram = vcl_proto_is_dgram (session->session_type);
479 session->listener_index = listen_session->session_index;
480 listen_session->n_accepted_sessions++;
482 VDBG (1, "session %u [0x%llx]: client accept request from %s address %U"
483 " port %d queue %p!", session->session_index, mp->handle,
484 mp->rmt.is_ip4 ? "IPv4" : "IPv6", format_ip46_address, &mp->rmt.ip,
485 mp->rmt.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
486 clib_net_to_host_u16 (mp->rmt.port), session->vpp_evt_q);
487 vcl_evt (VCL_EVT_ACCEPT, session, listen_session, session_index);
489 vcl_send_session_accepted_reply (session->vpp_evt_q, mp->context,
490 session->vpp_handle, 0);
492 return session->session_index;
495 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0),
496 mp->vpp_event_queue_address, mp->mq_index, &evt_q);
497 vcl_send_session_accepted_reply (evt_q, mp->context, mp->handle,
498 VNET_API_ERROR_INVALID_ARGUMENT);
499 vcl_session_free (wrk, session);
500 return VCL_INVALID_SESSION_INDEX;
504 vcl_session_connected_handler (vcl_worker_t * wrk,
505 session_connected_msg_t * mp)
507 vcl_session_t *session = 0;
510 session_index = mp->context;
511 session = vcl_session_get (wrk, session_index);
512 if (PREDICT_FALSE (!session))
514 VDBG (0, "ERROR: vpp handle 0x%llx has no session index (%u)!",
515 mp->handle, session_index);
516 /* Should not happen but if it does, force vpp session cleanup */
517 vcl_session_t tmp_session = {
518 .vpp_handle = mp->handle,
521 vcl_segment_attach_session (
522 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
523 mp->vpp_event_queue_address, mp->mq_index, 0, session);
524 if (tmp_session.vpp_evt_q)
525 vcl_send_session_disconnect (wrk, &tmp_session);
526 return VCL_INVALID_SESSION_INDEX;
530 VDBG (0, "ERROR: session index %u: connect failed! %U",
531 session_index, format_session_error, mp->retval);
532 session->session_state = VCL_STATE_DETACHED;
533 session->vpp_handle = mp->handle;
534 return session_index;
537 session->vpp_handle = mp->handle;
539 if (vcl_segment_attach_session (
540 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
541 mp->vpp_event_queue_address, mp->mq_index, 0, session))
543 VDBG (0, "failed to attach fifos for %u", session->session_index);
544 session->session_state = VCL_STATE_DETACHED;
545 vcl_send_session_disconnect (wrk, session);
546 return session_index;
551 if (vcl_segment_attach_session (mp->ct_segment_handle, mp->ct_rx_fifo,
552 mp->ct_tx_fifo, (uword) ~0, ~0, 1,
555 VDBG (0, "failed to attach ct fifos for %u", session->session_index);
556 session->session_state = VCL_STATE_DETACHED;
557 vcl_send_session_disconnect (wrk, session);
558 return session_index;
562 session->transport.is_ip4 = mp->lcl.is_ip4;
563 clib_memcpy_fast (&session->transport.lcl_ip, &mp->lcl.ip,
564 sizeof (session->transport.lcl_ip));
565 session->transport.lcl_port = mp->lcl.port;
567 /* Application closed session before connect reply */
568 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK)
569 && session->session_state == VCL_STATE_CLOSED)
570 vcl_send_session_disconnect (wrk, session);
572 session->session_state = VCL_STATE_READY;
574 /* Add it to lookup table */
575 vcl_session_table_add_vpp_handle (wrk, mp->handle, session_index);
577 VDBG (1, "session %u [0x%llx] connected! rx_fifo %p, refcnt %d, tx_fifo %p,"
578 " refcnt %d", session_index, mp->handle, session->rx_fifo,
579 session->rx_fifo->refcnt, session->tx_fifo, session->tx_fifo->refcnt);
581 return session_index;
585 vcl_flag_accepted_session (vcl_session_t * session, u64 handle, u32 flags)
587 vcl_session_msg_t *accepted_msg;
590 for (i = 0; i < vec_len (session->accept_evts_fifo); i++)
592 accepted_msg = &session->accept_evts_fifo[i];
593 if (accepted_msg->accepted_msg.handle == handle)
595 accepted_msg->flags |= flags;
603 vcl_session_reset_handler (vcl_worker_t * wrk,
604 session_reset_msg_t * reset_msg)
606 vcl_session_t *session;
609 sid = vcl_session_index_from_vpp_handle (wrk, reset_msg->handle);
610 session = vcl_session_get (wrk, sid);
613 VDBG (0, "request to reset unknown handle 0x%llx", reset_msg->handle);
614 return VCL_INVALID_SESSION_INDEX;
617 /* Caught a reset before actually accepting the session */
618 if (session->session_state == VCL_STATE_LISTEN)
621 if (!vcl_flag_accepted_session (session, reset_msg->handle,
622 VCL_ACCEPTED_F_RESET))
623 VDBG (0, "session was not accepted!");
624 return VCL_INVALID_SESSION_INDEX;
627 if (session->session_state != VCL_STATE_CLOSED)
628 session->session_state = VCL_STATE_DISCONNECT;
629 VDBG (0, "reset session %u [0x%llx]", sid, reset_msg->handle);
634 vcl_session_bound_handler (vcl_worker_t * wrk, session_bound_msg_t * mp)
636 vcl_session_t *session;
637 u32 sid = mp->context;
639 session = vcl_session_get (wrk, sid);
642 VERR ("session %u [0x%llx]: bind failed: %U", sid, mp->handle,
643 format_session_error, mp->retval);
646 session->session_state = VCL_STATE_DETACHED;
647 session->vpp_handle = mp->handle;
652 VDBG (0, "ERROR: session %u [0x%llx]: Invalid session index!",
654 return VCL_INVALID_SESSION_INDEX;
658 session->vpp_handle = mp->handle;
659 session->transport.is_ip4 = mp->lcl_is_ip4;
660 clib_memcpy_fast (&session->transport.lcl_ip, mp->lcl_ip,
661 sizeof (ip46_address_t));
662 session->transport.lcl_port = mp->lcl_port;
663 vcl_session_table_add_listener (wrk, mp->handle, sid);
664 session->session_state = VCL_STATE_LISTEN;
666 if (vcl_session_is_cl (session))
668 if (vcl_segment_attach_session (mp->segment_handle, mp->rx_fifo,
669 mp->tx_fifo, mp->vpp_evt_q, mp->mq_index,
672 VDBG (0, "failed to attach fifos for %u", session->session_index);
673 session->session_state = VCL_STATE_DETACHED;
674 return VCL_INVALID_SESSION_INDEX;
678 VDBG (0, "session %u [0x%llx]: listen succeeded!", sid, mp->handle);
683 vcl_session_unlisten_reply_handler (vcl_worker_t * wrk, void *data)
685 session_unlisten_reply_msg_t *mp = (session_unlisten_reply_msg_t *) data;
688 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
691 VDBG (0, "Unlisten reply with wrong handle %llx", mp->handle);
694 if (s->session_state != VCL_STATE_DISCONNECT)
696 /* Connected udp listener */
697 if (s->session_type == VPPCOM_PROTO_UDP
698 && s->session_state == VCL_STATE_CLOSED)
701 VDBG (0, "Unlisten session in wrong state %llx", mp->handle);
706 VDBG (0, "ERROR: session %u [0xllx]: unlisten failed: %U",
707 s->session_index, mp->handle, format_session_error, mp->retval);
709 if (mp->context != wrk->wrk_index)
710 VDBG (0, "wrong context");
712 vcl_session_table_del_vpp_handle (wrk, mp->handle);
713 vcl_session_free (wrk, s);
717 vcl_session_migrated_handler (vcl_worker_t * wrk, void *data)
719 session_migrated_msg_t *mp = (session_migrated_msg_t *) data;
723 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
726 VDBG (0, "Migrated notification with wrong handle %llx", mp->handle);
730 /* Only validate if a value is provided */
731 if (mp->segment_handle != SESSION_INVALID_HANDLE)
733 fs_index = vcl_segment_table_lookup (mp->segment_handle);
734 if (fs_index == VCL_INVALID_SEGMENT_INDEX)
736 VDBG (0, "segment %lx for session %u is not mounted!",
737 mp->segment_handle, s->session_index);
738 s->session_state = VCL_STATE_DETACHED;
743 s->vpp_handle = mp->new_handle;
745 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0), mp->vpp_evt_q,
746 mp->vpp_thread_index, &s->vpp_evt_q);
748 vcl_session_table_del_vpp_handle (wrk, mp->handle);
749 vcl_session_table_add_vpp_handle (wrk, mp->new_handle, s->session_index);
751 /* Generate new tx event if we have outstanding data */
752 if (svm_fifo_has_event (s->tx_fifo))
753 app_send_io_evt_to_vpp (s->vpp_evt_q,
754 s->tx_fifo->shr->master_session_index,
755 SESSION_IO_EVT_TX, SVM_Q_WAIT);
757 VDBG (0, "Migrated 0x%lx to thread %u 0x%lx", mp->handle,
758 mp->vpp_thread_index, mp->new_handle);
761 static vcl_session_t *
762 vcl_session_accepted (vcl_worker_t * wrk, session_accepted_msg_t * msg)
764 vcl_session_msg_t *vcl_msg;
765 vcl_session_t *session;
767 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
768 if (PREDICT_FALSE (session != 0))
769 VWRN ("session overlap handle %lu state %u!", msg->handle,
770 session->session_state);
772 session = vcl_session_table_lookup_listener (wrk, msg->listener_handle);
775 VERR ("couldn't find listen session: listener handle %llx",
776 msg->listener_handle);
780 clib_fifo_add2 (session->accept_evts_fifo, vcl_msg);
782 vcl_msg->accepted_msg = *msg;
783 /* Session handle points to listener until fully accepted by app */
784 vcl_session_table_add_vpp_handle (wrk, msg->handle, session->session_index);
789 static vcl_session_t *
790 vcl_session_disconnected_handler (vcl_worker_t * wrk,
791 session_disconnected_msg_t * msg)
793 vcl_session_t *session;
795 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
798 VDBG (0, "request to disconnect unknown handle 0x%llx", msg->handle);
802 /* Late disconnect notification on a session that has been closed */
803 if (session->session_state == VCL_STATE_CLOSED)
806 /* Caught a disconnect before actually accepting the session */
807 if (session->session_state == VCL_STATE_LISTEN)
809 if (!vcl_flag_accepted_session (session, msg->handle,
810 VCL_ACCEPTED_F_CLOSED))
811 VDBG (0, "session was not accepted!");
815 /* If not already reset change state */
816 if (session->session_state != VCL_STATE_DISCONNECT)
817 session->session_state = VCL_STATE_VPP_CLOSING;
823 vppcom_session_shutdown (uint32_t session_handle, int how)
825 vcl_worker_t *wrk = vcl_worker_get_current ();
826 vcl_session_t *session;
827 vcl_session_state_t state;
830 session = vcl_session_get_w_handle (wrk, session_handle);
831 if (PREDICT_FALSE (!session))
832 return VPPCOM_EBADFD;
834 vpp_handle = session->vpp_handle;
835 state = session->session_state;
837 VDBG (1, "session %u [0x%llx] state 0x%x (%s)", session->session_index,
838 vpp_handle, state, vppcom_session_state_str (state));
840 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
842 VDBG (0, "ERROR: Cannot shutdown a listen socket!");
843 return VPPCOM_EBADFD;
846 if (how == SHUT_RD || how == SHUT_RDWR)
848 session->flags |= VCL_SESSION_F_RD_SHUTDOWN;
852 session->flags |= VCL_SESSION_F_WR_SHUTDOWN;
854 if (PREDICT_TRUE (state == VCL_STATE_READY))
856 VDBG (1, "session %u [0x%llx]: sending shutdown...",
857 session->session_index, vpp_handle);
859 vcl_send_session_shutdown (wrk, session);
866 vppcom_session_disconnect (u32 session_handle)
868 vcl_worker_t *wrk = vcl_worker_get_current ();
869 vcl_session_t *session, *listen_session;
870 vcl_session_state_t state;
873 session = vcl_session_get_w_handle (wrk, session_handle);
875 return VPPCOM_EBADFD;
877 vpp_handle = session->vpp_handle;
878 state = session->session_state;
880 VDBG (1, "session %u [0x%llx] state 0x%x (%s)", session->session_index,
881 vpp_handle, state, vppcom_session_state_str (state));
883 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
885 VDBG (0, "ERROR: Cannot disconnect a listen socket!");
886 return VPPCOM_EBADFD;
889 if (state == VCL_STATE_VPP_CLOSING)
891 vcl_send_session_disconnected_reply (wrk, session, 0);
892 VDBG (1, "session %u [0x%llx]: sending disconnect REPLY...",
893 session->session_index, vpp_handle);
897 /* Session doesn't have an event queue yet. Probably a non-blocking
898 * connect. Wait for the reply */
899 if (PREDICT_FALSE (!session->vpp_evt_q))
902 VDBG (1, "session %u [0x%llx]: sending disconnect...",
903 session->session_index, vpp_handle);
904 vcl_send_session_disconnect (wrk, session);
907 if (session->listener_index != VCL_INVALID_SESSION_INDEX)
909 listen_session = vcl_session_get (wrk, session->listener_index);
910 listen_session->n_accepted_sessions--;
917 vcl_session_cleanup_handler (vcl_worker_t * wrk, void *data)
919 session_cleanup_msg_t *msg;
920 vcl_session_t *session;
922 msg = (session_cleanup_msg_t *) data;
923 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
926 VDBG (0, "disconnect confirmed for unknown handle 0x%llx", msg->handle);
930 if (msg->type == SESSION_CLEANUP_TRANSPORT)
932 /* Transport was cleaned up before we confirmed close. Probably the
933 * app is still waiting for some data that cannot be delivered.
934 * Confirm close to make sure everything is cleaned up.
935 * Move to undetermined state to ensure that the session is not
936 * removed before both vpp and the app cleanup.
937 * - If the app closes first, the session is moved to CLOSED state
938 * and the session cleanup notification from vpp removes the
940 * - If vpp cleans up the session first, the session is moved to
941 * DETACHED state lower and subsequently the close from the app
944 if (session->session_state == VCL_STATE_VPP_CLOSING)
946 vppcom_session_disconnect (vcl_session_handle (session));
947 session->session_state = VCL_STATE_UPDATED;
949 else if (session->session_state == VCL_STATE_DISCONNECT)
951 vcl_send_session_reset_reply (wrk, session, 0);
952 session->session_state = VCL_STATE_UPDATED;
957 vcl_session_table_del_vpp_handle (wrk, msg->handle);
958 /* Should not happen. App did not close the connection so don't free it. */
959 if (session->session_state != VCL_STATE_CLOSED)
961 VDBG (0, "app did not close session %d", session->session_index);
962 session->session_state = VCL_STATE_DETACHED;
963 session->vpp_handle = VCL_INVALID_SESSION_HANDLE;
966 vcl_session_free (wrk, session);
970 vcl_session_req_worker_update_handler (vcl_worker_t * wrk, void *data)
972 session_req_worker_update_msg_t *msg;
975 msg = (session_req_worker_update_msg_t *) data;
976 s = vcl_session_get_w_vpp_handle (wrk, msg->session_handle);
980 vec_add1 (wrk->pending_session_wrk_updates, s->session_index);
984 vcl_session_worker_update_reply_handler (vcl_worker_t * wrk, void *data)
986 session_worker_update_reply_msg_t *msg;
989 msg = (session_worker_update_reply_msg_t *) data;
990 s = vcl_session_get_w_vpp_handle (wrk, msg->handle);
993 VDBG (0, "unknown handle 0x%llx", msg->handle);
999 if (vcl_segment_attach_session (msg->segment_handle, msg->rx_fifo,
1000 msg->tx_fifo, (uword) ~0, ~0, 0, s))
1002 VDBG (0, "failed to attach fifos for %u", s->session_index);
1006 s->session_state = VCL_STATE_UPDATED;
1008 VDBG (0, "session %u[0x%llx] moved to worker %u", s->session_index,
1009 s->vpp_handle, wrk->wrk_index);
1013 vcl_api_recv_fd (vcl_worker_t * wrk, int *fds, int n_fds)
1016 if (vcm->cfg.vpp_app_socket_api)
1017 return vcl_sapi_recv_fds (wrk, fds, n_fds);
1019 return vcl_bapi_recv_fds (wrk, fds, n_fds);
1023 vcl_session_app_add_segment_handler (vcl_worker_t * wrk, void *data)
1025 ssvm_segment_type_t seg_type = SSVM_SEGMENT_SHM;
1026 session_app_add_segment_msg_t *msg;
1030 msg = (session_app_add_segment_msg_t *) data;
1034 vcl_api_recv_fd (wrk, &fd, 1);
1035 seg_type = SSVM_SEGMENT_MEMFD;
1038 segment_handle = msg->segment_handle;
1039 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
1041 clib_warning ("invalid segment handle");
1045 if (vcl_segment_attach (segment_handle, (char *) msg->segment_name,
1048 VDBG (0, "vcl_segment_attach ('%s') failed", msg->segment_name);
1052 VDBG (1, "mapped new segment '%s' size %d", msg->segment_name,
1057 vcl_session_app_del_segment_handler (vcl_worker_t * wrk, void *data)
1059 session_app_del_segment_msg_t *msg = (session_app_del_segment_msg_t *) data;
1060 vcl_segment_detach (msg->segment_handle);
1061 VDBG (1, "Unmapped segment: %d", msg->segment_handle);
1065 vcl_worker_rpc_handler (vcl_worker_t * wrk, void *data)
1067 if (!vcm->wrk_rpc_fn)
1070 (vcm->wrk_rpc_fn) (((session_app_wrk_rpc_msg_t *) data)->data);
1074 vcl_session_transport_attr_reply_handler (vcl_worker_t *wrk, void *data)
1076 session_transport_attr_reply_msg_t *mp;
1078 if (!wrk->session_attr_op)
1081 mp = (session_transport_attr_reply_msg_t *) data;
1083 wrk->session_attr_op_rv = mp->retval;
1084 wrk->session_attr_op = 0;
1085 wrk->session_attr_rv = mp->attr;
1089 vcl_handle_mq_event (vcl_worker_t * wrk, session_event_t * e)
1091 session_disconnected_msg_t *disconnected_msg;
1092 session_connected_msg_t *connected_msg;
1093 session_reset_msg_t *reset_msg;
1094 session_event_t *ecpy;
1098 switch (e->event_type)
1100 case SESSION_IO_EVT_RX:
1101 case SESSION_IO_EVT_TX:
1102 s = vcl_session_get (wrk, e->session_index);
1103 if (!s || !vcl_session_is_open (s))
1105 vec_add1 (wrk->unhandled_evts_vector, *e);
1107 case SESSION_CTRL_EVT_BOUND:
1108 /* We can only wait for only one listen so not postponed */
1109 vcl_session_bound_handler (wrk, (session_bound_msg_t *) e->data);
1111 case SESSION_CTRL_EVT_ACCEPTED:
1112 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
1113 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1115 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1117 ecpy->postponed = 1;
1118 ecpy->session_index = s->session_index;
1121 case SESSION_CTRL_EVT_CONNECTED:
1122 connected_msg = (session_connected_msg_t *) e->data;
1123 sid = vcl_session_connected_handler (wrk, connected_msg);
1124 if (!(s = vcl_session_get (wrk, sid)))
1126 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1128 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1130 ecpy->postponed = 1;
1131 ecpy->session_index = s->session_index;
1134 case SESSION_CTRL_EVT_DISCONNECTED:
1135 disconnected_msg = (session_disconnected_msg_t *) e->data;
1136 if (!(s = vcl_session_get_w_vpp_handle (wrk, disconnected_msg->handle)))
1138 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1140 vec_add1 (wrk->unhandled_evts_vector, *e);
1143 if (!(s = vcl_session_disconnected_handler (wrk, disconnected_msg)))
1145 VDBG (0, "disconnected session %u [0x%llx]", s->session_index,
1148 case SESSION_CTRL_EVT_RESET:
1149 reset_msg = (session_reset_msg_t *) e->data;
1150 if (!(s = vcl_session_get_w_vpp_handle (wrk, reset_msg->handle)))
1152 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1154 vec_add1 (wrk->unhandled_evts_vector, *e);
1157 vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
1159 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
1160 vcl_session_unlisten_reply_handler (wrk, e->data);
1162 case SESSION_CTRL_EVT_MIGRATED:
1163 vcl_session_migrated_handler (wrk, e->data);
1165 case SESSION_CTRL_EVT_CLEANUP:
1166 vcl_session_cleanup_handler (wrk, e->data);
1168 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
1169 vcl_session_req_worker_update_handler (wrk, e->data);
1171 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
1172 vcl_session_worker_update_reply_handler (wrk, e->data);
1174 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
1175 vcl_session_app_add_segment_handler (wrk, e->data);
1177 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
1178 vcl_session_app_del_segment_handler (wrk, e->data);
1180 case SESSION_CTRL_EVT_APP_WRK_RPC:
1181 vcl_worker_rpc_handler (wrk, e->data);
1183 case SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY:
1184 vcl_session_transport_attr_reply_handler (wrk, e->data);
1187 clib_warning ("unhandled %u", e->event_type);
1193 vppcom_wait_for_session_state_change (u32 session_index,
1194 vcl_session_state_t state,
1197 vcl_worker_t *wrk = vcl_worker_get_current ();
1198 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
1199 vcl_session_t *volatile session;
1200 svm_msg_q_msg_t msg;
1205 session = vcl_session_get (wrk, session_index);
1206 if (PREDICT_FALSE (!session))
1208 return VPPCOM_EBADFD;
1210 if (session->session_state == state)
1214 if (session->session_state == VCL_STATE_DETACHED)
1216 return VPPCOM_ECONNREFUSED;
1219 if (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0))
1224 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
1225 vcl_handle_mq_event (wrk, e);
1226 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
1228 while (clib_time_now (&wrk->clib_time) < timeout);
1230 VDBG (0, "timeout waiting for state 0x%x (%s)", state,
1231 vppcom_session_state_str (state));
1232 vcl_evt (VCL_EVT_SESSION_TIMEOUT, session, session_state);
1234 return VPPCOM_ETIMEDOUT;
1238 vcl_handle_pending_wrk_updates (vcl_worker_t * wrk)
1240 vcl_session_state_t state;
1244 if (PREDICT_TRUE (vec_len (wrk->pending_session_wrk_updates) == 0))
1247 vec_foreach (sip, wrk->pending_session_wrk_updates)
1249 s = vcl_session_get (wrk, *sip);
1250 vcl_send_session_worker_update (wrk, s, wrk->wrk_index);
1251 state = s->session_state;
1252 vppcom_wait_for_session_state_change (s->session_index, VCL_STATE_UPDATED,
1254 s->session_state = state;
1256 vec_reset_length (wrk->pending_session_wrk_updates);
1260 vcl_worker_flush_mq_events (vcl_worker_t *wrk)
1262 svm_msg_q_msg_t *msg;
1267 mq = wrk->app_event_queue;
1268 vcl_mq_dequeue_batch (wrk, mq, ~0);
1270 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
1272 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
1273 e = svm_msg_q_msg_data (mq, msg);
1274 vcl_handle_mq_event (wrk, e);
1275 svm_msg_q_free_msg (mq, msg);
1277 vec_reset_length (wrk->mq_msg_vector);
1278 vcl_handle_pending_wrk_updates (wrk);
1282 vcl_flush_mq_events (void)
1284 vcl_worker_flush_mq_events (vcl_worker_get_current ());
1288 vppcom_session_unbind (u32 session_handle)
1290 vcl_worker_t *wrk = vcl_worker_get_current ();
1291 session_accepted_msg_t *accepted_msg;
1292 vcl_session_t *session = 0;
1293 vcl_session_msg_t *evt;
1295 session = vcl_session_get_w_handle (wrk, session_handle);
1297 return VPPCOM_EBADFD;
1299 /* Flush pending accept events, if any */
1300 while (clib_fifo_elts (session->accept_evts_fifo))
1302 clib_fifo_sub2 (session->accept_evts_fifo, evt);
1303 accepted_msg = &evt->accepted_msg;
1304 vcl_session_table_del_vpp_handle (wrk, accepted_msg->handle);
1305 vcl_send_session_accepted_reply (session->vpp_evt_q,
1306 accepted_msg->context,
1307 accepted_msg->handle, -1);
1309 clib_fifo_free (session->accept_evts_fifo);
1311 vcl_send_session_unlisten (wrk, session);
1313 VDBG (1, "session %u [0x%llx]: sending unbind!", session->session_index,
1314 session->vpp_handle);
1315 vcl_evt (VCL_EVT_UNBIND, session);
1317 session->vpp_handle = ~0;
1318 session->session_state = VCL_STATE_DISCONNECT;
1326 * Notify vpp of the disconnect and mark the worker as free. If we're the
1327 * last worker, do a full cleanup otherwise, since we're probably a forked
1328 * child, avoid syscalls as much as possible. We might've lost privileges.
1331 vppcom_app_exit (void)
1333 if (!pool_elts (vcm->workers))
1335 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
1336 vcl_set_worker_index (~0);
1337 vcl_elog_stop (vcm);
1341 vcl_api_attach (void)
1343 if (vcm->cfg.vpp_app_socket_api)
1344 return vcl_sapi_attach ();
1346 return vcl_bapi_attach ();
1350 vcl_api_detach (vcl_worker_t * wrk)
1352 vcl_send_app_detach (wrk);
1354 if (vcm->cfg.vpp_app_socket_api)
1355 return vcl_sapi_detach (wrk);
1357 return vcl_bapi_disconnect_from_vpp ();
1361 * VPPCOM Public API functions
1364 vppcom_app_create (const char *app_name)
1366 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1371 VDBG (1, "already initialized");
1372 return VPPCOM_EEXIST;
1376 vppcom_cfg (&vcm->cfg);
1377 vcl_cfg = &vcm->cfg;
1379 vcm->main_cpu = pthread_self ();
1380 vcm->main_pid = getpid ();
1381 vcm->app_name = format (0, "%s", app_name);
1382 fifo_segment_main_init (&vcm->segment_main, (uword) ~0,
1383 20 /* timeout in secs */);
1384 pool_alloc (vcm->workers, vcl_cfg->max_workers);
1385 clib_spinlock_init (&vcm->workers_lock);
1386 clib_rwlock_init (&vcm->segment_table_lock);
1387 atexit (vppcom_app_exit);
1388 vcl_elog_init (vcm);
1390 /* Allocate default worker */
1391 vcl_worker_alloc_and_init ();
1393 if ((rv = vcl_api_attach ()))
1396 VDBG (0, "app_name '%s', my_client_index %d (0x%x)", app_name,
1397 vcm->workers[0].api_client_handle, vcm->workers[0].api_client_handle);
1403 vppcom_app_destroy (void)
1405 vcl_worker_t *wrk, *current_wrk;
1408 if (!pool_elts (vcm->workers))
1411 vcl_evt (VCL_EVT_DETACH, vcm);
1413 current_wrk = vcl_worker_get_current ();
1416 pool_foreach (wrk, vcm->workers) {
1417 if (current_wrk != wrk)
1418 vcl_worker_cleanup (wrk, 0 /* notify vpp */ );
1422 vcl_api_detach (current_wrk);
1423 vcl_worker_cleanup (current_wrk, 0 /* notify vpp */ );
1425 vcl_elog_stop (vcm);
1428 * Free the heap and fix vcm
1430 heap = clib_mem_get_heap ();
1431 munmap (clib_mem_get_heap_base (heap), clib_mem_get_heap_size (heap));
1433 vcm = &_vppcom_main;
1438 vppcom_session_create (u8 proto, u8 is_nonblocking)
1440 vcl_worker_t *wrk = vcl_worker_get_current ();
1441 vcl_session_t *session;
1443 session = vcl_session_alloc (wrk);
1445 session->session_type = proto;
1446 session->session_state = VCL_STATE_CLOSED;
1447 session->vpp_handle = ~0;
1448 session->is_dgram = vcl_proto_is_dgram (proto);
1451 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
1453 vcl_evt (VCL_EVT_CREATE, session, session_type, session->session_state,
1454 is_nonblocking, session_index);
1456 VDBG (0, "created session %u", session->session_index);
1458 return vcl_session_handle (session);
1462 vcl_epoll_lt_add (vcl_worker_t *wrk, vcl_session_t *s)
1464 vcl_session_t *cur, *prev;
1466 if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX)
1468 wrk->ep_lt_current = s->session_index;
1469 s->vep.lt_next = s->session_index;
1470 s->vep.lt_prev = s->session_index;
1474 cur = vcl_session_get (wrk, wrk->ep_lt_current);
1475 prev = vcl_session_get (wrk, cur->vep.lt_prev);
1477 prev->vep.lt_next = s->session_index;
1478 s->vep.lt_prev = prev->session_index;
1480 s->vep.lt_next = cur->session_index;
1481 cur->vep.lt_prev = s->session_index;
1485 vcl_epoll_lt_del (vcl_worker_t *wrk, vcl_session_t *s)
1487 vcl_session_t *prev, *next;
1489 if (s->vep.lt_next == s->session_index)
1491 wrk->ep_lt_current = VCL_INVALID_SESSION_INDEX;
1492 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
1496 prev = vcl_session_get (wrk, s->vep.lt_prev);
1497 next = vcl_session_get (wrk, s->vep.lt_next);
1499 prev->vep.lt_next = next->session_index;
1500 next->vep.lt_prev = prev->session_index;
1502 if (s->session_index == wrk->ep_lt_current)
1503 wrk->ep_lt_current = s->vep.lt_next;
1505 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
1509 vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * s,
1510 vcl_session_handle_t sh, u8 do_disconnect)
1514 VDBG (1, "session %u [0x%llx] closing", s->session_index, s->vpp_handle);
1516 if (s->flags & VCL_SESSION_F_IS_VEP)
1518 u32 next_sh = s->vep.next_sh;
1519 while (next_sh != ~0)
1521 rv = vppcom_epoll_ctl (sh, EPOLL_CTL_DEL, next_sh, 0);
1522 if (PREDICT_FALSE (rv < 0))
1523 VDBG (0, "vpp handle 0x%llx, sh %u: EPOLL_CTL_DEL vep_idx %u"
1524 " failed! rv %d (%s)", s->vpp_handle, next_sh,
1525 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1526 next_sh = s->vep.next_sh;
1531 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
1533 rv = vppcom_epoll_ctl (s->vep.vep_sh, EPOLL_CTL_DEL, sh, 0);
1535 VDBG (0, "session %u [0x%llx]: EPOLL_CTL_DEL vep_idx %u "
1536 "failed! rv %d (%s)", s->session_index, s->vpp_handle,
1537 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1542 VDBG (1, "session %u [0x%llx] disconnect skipped",
1543 s->session_index, s->vpp_handle);
1547 if (s->session_state == VCL_STATE_LISTEN)
1549 rv = vppcom_session_unbind (sh);
1550 if (PREDICT_FALSE (rv < 0))
1551 VDBG (0, "session %u [0x%llx]: listener unbind failed! "
1552 "rv %d (%s)", s->session_index, s->vpp_handle, rv,
1553 vppcom_retval_str (rv));
1556 else if (vcl_session_is_ready (s)
1557 || (vcl_session_is_connectable_listener (wrk, s)))
1559 rv = vppcom_session_disconnect (sh);
1560 if (PREDICT_FALSE (rv < 0))
1561 VDBG (0, "ERROR: session %u [0x%llx]: disconnect failed!"
1562 " rv %d (%s)", s->session_index, s->vpp_handle,
1563 rv, vppcom_retval_str (rv));
1565 else if (s->session_state == VCL_STATE_DISCONNECT)
1567 vcl_send_session_reset_reply (wrk, s, 0);
1569 else if (s->session_state == VCL_STATE_DETACHED)
1571 /* Should not happen. VPP cleaned up before app confirmed close */
1572 VDBG (0, "vpp freed session %d before close", s->session_index);
1576 s->session_state = VCL_STATE_CLOSED;
1578 /* Session is removed only after vpp confirms the disconnect */
1582 vcl_session_table_del_vpp_handle (wrk, s->vpp_handle);
1584 vcl_session_free (wrk, s);
1585 vcl_evt (VCL_EVT_CLOSE, s, rv);
1591 vppcom_session_close (uint32_t session_handle)
1593 vcl_worker_t *wrk = vcl_worker_get_current ();
1594 vcl_session_t *session;
1596 session = vcl_session_get_w_handle (wrk, session_handle);
1598 return VPPCOM_EBADFD;
1599 return vcl_session_cleanup (wrk, session, session_handle,
1600 1 /* do_disconnect */ );
1604 vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep)
1606 vcl_worker_t *wrk = vcl_worker_get_current ();
1607 vcl_session_t *session = 0;
1610 return VPPCOM_EINVAL;
1612 session = vcl_session_get_w_handle (wrk, session_handle);
1614 return VPPCOM_EBADFD;
1616 if (session->flags & VCL_SESSION_F_IS_VEP)
1618 VDBG (0, "ERROR: cannot bind to epoll session %u!",
1619 session->session_index);
1620 return VPPCOM_EBADFD;
1623 session->transport.is_ip4 = ep->is_ip4;
1625 clib_memcpy_fast (&session->transport.lcl_ip.ip4, ep->ip,
1626 sizeof (ip4_address_t));
1628 clib_memcpy_fast (&session->transport.lcl_ip.ip6, ep->ip,
1629 sizeof (ip6_address_t));
1630 session->transport.lcl_port = ep->port;
1632 VDBG (0, "session %u handle %u: binding to local %s address %U port %u, "
1633 "proto %s", session->session_index, session_handle,
1634 session->transport.is_ip4 ? "IPv4" : "IPv6",
1635 format_ip46_address, &session->transport.lcl_ip,
1636 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1637 clib_net_to_host_u16 (session->transport.lcl_port),
1638 vppcom_proto_str (session->session_type));
1639 vcl_evt (VCL_EVT_BIND, session);
1641 if (session->session_type == VPPCOM_PROTO_UDP)
1642 vppcom_session_listen (session_handle, 10);
1648 vppcom_session_listen (uint32_t listen_sh, uint32_t q_len)
1650 vcl_worker_t *wrk = vcl_worker_get_current ();
1651 vcl_session_t *listen_session = 0;
1652 u64 listen_vpp_handle;
1655 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1656 if (!listen_session || (listen_session->flags & VCL_SESSION_F_IS_VEP))
1657 return VPPCOM_EBADFD;
1659 listen_vpp_handle = listen_session->vpp_handle;
1660 if (listen_session->session_state == VCL_STATE_LISTEN)
1662 VDBG (0, "session %u [0x%llx]: already in listen state!",
1663 listen_sh, listen_vpp_handle);
1667 VDBG (0, "session %u: sending vpp listen request...", listen_sh);
1670 * Send listen request to vpp and wait for reply
1672 vcl_send_session_listen (wrk, listen_session);
1673 rv = vppcom_wait_for_session_state_change (listen_session->session_index,
1675 vcm->cfg.session_timeout);
1677 if (PREDICT_FALSE (rv))
1679 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1680 VDBG (0, "session %u [0x%llx]: listen failed! returning %d (%s)",
1681 listen_sh, listen_session->vpp_handle, rv,
1682 vppcom_retval_str (rv));
1690 validate_args_session_accept_ (vcl_worker_t * wrk, vcl_session_t * ls)
1692 if (ls->flags & VCL_SESSION_F_IS_VEP)
1694 VDBG (0, "ERROR: cannot accept on epoll session %u!",
1696 return VPPCOM_EBADFD;
1699 if ((ls->session_state != VCL_STATE_LISTEN)
1700 && (!vcl_session_is_connectable_listener (wrk, ls)))
1702 VDBG (0, "ERROR: session [0x%llx]: not in listen state! state 0x%x"
1703 " (%s)", ls->vpp_handle, ls->session_state,
1704 vppcom_session_state_str (ls->session_state));
1705 return VPPCOM_EBADFD;
1711 vppcom_unformat_proto (uint8_t * proto, char *proto_str)
1713 if (!strcmp (proto_str, "TCP"))
1714 *proto = VPPCOM_PROTO_TCP;
1715 else if (!strcmp (proto_str, "tcp"))
1716 *proto = VPPCOM_PROTO_TCP;
1717 else if (!strcmp (proto_str, "UDP"))
1718 *proto = VPPCOM_PROTO_UDP;
1719 else if (!strcmp (proto_str, "udp"))
1720 *proto = VPPCOM_PROTO_UDP;
1721 else if (!strcmp (proto_str, "TLS"))
1722 *proto = VPPCOM_PROTO_TLS;
1723 else if (!strcmp (proto_str, "tls"))
1724 *proto = VPPCOM_PROTO_TLS;
1725 else if (!strcmp (proto_str, "QUIC"))
1726 *proto = VPPCOM_PROTO_QUIC;
1727 else if (!strcmp (proto_str, "quic"))
1728 *proto = VPPCOM_PROTO_QUIC;
1729 else if (!strcmp (proto_str, "DTLS"))
1730 *proto = VPPCOM_PROTO_DTLS;
1731 else if (!strcmp (proto_str, "dtls"))
1732 *proto = VPPCOM_PROTO_DTLS;
1733 else if (!strcmp (proto_str, "SRTP"))
1734 *proto = VPPCOM_PROTO_SRTP;
1735 else if (!strcmp (proto_str, "srtp"))
1736 *proto = VPPCOM_PROTO_SRTP;
1743 vppcom_session_accept (uint32_t listen_session_handle, vppcom_endpt_t * ep,
1746 u32 client_session_index = ~0, listen_session_index, accept_flags = 0;
1747 vcl_worker_t *wrk = vcl_worker_get_current ();
1748 session_accepted_msg_t accepted_msg;
1749 vcl_session_t *listen_session = 0;
1750 vcl_session_t *client_session = 0;
1751 vcl_session_msg_t *evt;
1757 listen_session = vcl_session_get_w_handle (wrk, listen_session_handle);
1758 if (!listen_session)
1759 return VPPCOM_EBADFD;
1761 listen_session_index = listen_session->session_index;
1762 if ((rv = validate_args_session_accept_ (wrk, listen_session)))
1765 if (clib_fifo_elts (listen_session->accept_evts_fifo))
1767 clib_fifo_sub2 (listen_session->accept_evts_fifo, evt);
1768 accept_flags = evt->flags;
1769 accepted_msg = evt->accepted_msg;
1773 is_nonblocking = vcl_session_has_attr (listen_session,
1774 VCL_SESS_ATTR_NONBLOCK);
1777 if (svm_msg_q_is_empty (wrk->app_event_queue) && is_nonblocking)
1778 return VPPCOM_EAGAIN;
1780 svm_msg_q_wait (wrk->app_event_queue, SVM_MQ_WAIT_EMPTY);
1781 vcl_worker_flush_mq_events (wrk);
1787 client_session_index = vcl_session_accepted_handler (wrk, &accepted_msg,
1788 listen_session_index);
1789 if (client_session_index == VCL_INVALID_SESSION_INDEX)
1790 return VPPCOM_ECONNABORTED;
1792 listen_session = vcl_session_get (wrk, listen_session_index);
1793 client_session = vcl_session_get (wrk, client_session_index);
1795 if (flags & O_NONBLOCK)
1796 vcl_session_set_attr (client_session, VCL_SESS_ATTR_NONBLOCK);
1798 VDBG (1, "listener %u [0x%llx]: Got a connect request! session %u [0x%llx],"
1799 " flags %d, is_nonblocking %u", listen_session->session_index,
1800 listen_session->vpp_handle, client_session_index,
1801 client_session->vpp_handle, flags,
1802 vcl_session_has_attr (client_session, VCL_SESS_ATTR_NONBLOCK));
1806 ep->is_ip4 = client_session->transport.is_ip4;
1807 ep->port = client_session->transport.rmt_port;
1808 if (client_session->transport.is_ip4)
1809 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip4,
1810 sizeof (ip4_address_t));
1812 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip6,
1813 sizeof (ip6_address_t));
1816 VDBG (0, "listener %u [0x%llx] accepted %u [0x%llx] peer: %U:%u "
1817 "local: %U:%u", listen_session_handle, listen_session->vpp_handle,
1818 client_session_index, client_session->vpp_handle,
1819 format_ip46_address, &client_session->transport.rmt_ip,
1820 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1821 clib_net_to_host_u16 (client_session->transport.rmt_port),
1822 format_ip46_address, &client_session->transport.lcl_ip,
1823 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1824 clib_net_to_host_u16 (client_session->transport.lcl_port));
1825 vcl_evt (VCL_EVT_ACCEPT, client_session, listen_session,
1826 client_session_index);
1829 * Session might have been closed already
1833 if (accept_flags & VCL_ACCEPTED_F_CLOSED)
1834 client_session->session_state = VCL_STATE_VPP_CLOSING;
1835 else if (accept_flags & VCL_ACCEPTED_F_RESET)
1836 client_session->session_state = VCL_STATE_DISCONNECT;
1838 return vcl_session_handle (client_session);
1842 vppcom_session_connect (uint32_t session_handle, vppcom_endpt_t * server_ep)
1844 vcl_worker_t *wrk = vcl_worker_get_current ();
1845 vcl_session_t *session = 0;
1849 session = vcl_session_get_w_handle (wrk, session_handle);
1851 return VPPCOM_EBADFD;
1852 session_index = session->session_index;
1854 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1856 VDBG (0, "ERROR: cannot connect epoll session %u!",
1857 session->session_index);
1858 return VPPCOM_EBADFD;
1861 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1863 VDBG (0, "session handle %u [0x%llx]: session already "
1864 "connected to %s %U port %d proto %s, state 0x%x (%s)",
1865 session_handle, session->vpp_handle,
1866 session->transport.is_ip4 ? "IPv4" : "IPv6", format_ip46_address,
1867 &session->transport.rmt_ip, session->transport.is_ip4 ?
1868 IP46_TYPE_IP4 : IP46_TYPE_IP6,
1869 clib_net_to_host_u16 (session->transport.rmt_port),
1870 vppcom_proto_str (session->session_type), session->session_state,
1871 vppcom_session_state_str (session->session_state));
1875 /* Attempt to connect a connectionless listener */
1876 if (PREDICT_FALSE (session->session_state == VCL_STATE_LISTEN))
1878 if (session->session_type != VPPCOM_PROTO_UDP)
1879 return VPPCOM_EINVAL;
1880 vcl_send_session_unlisten (wrk, session);
1881 session->session_state = VCL_STATE_CLOSED;
1884 session->transport.is_ip4 = server_ep->is_ip4;
1885 vcl_ip_copy_from_ep (&session->transport.rmt_ip, server_ep);
1886 session->transport.rmt_port = server_ep->port;
1887 session->parent_handle = VCL_INVALID_SESSION_HANDLE;
1888 session->flags |= VCL_SESSION_F_CONNECTED;
1890 VDBG (0, "session handle %u (%s): connecting to peer %s %U "
1891 "port %d proto %s", session_handle,
1892 vppcom_session_state_str (session->session_state),
1893 session->transport.is_ip4 ? "IPv4" : "IPv6",
1894 format_ip46_address,
1895 &session->transport.rmt_ip, session->transport.is_ip4 ?
1896 IP46_TYPE_IP4 : IP46_TYPE_IP6,
1897 clib_net_to_host_u16 (session->transport.rmt_port),
1898 vppcom_proto_str (session->session_type));
1900 vcl_send_session_connect (wrk, session);
1902 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK))
1904 /* State set to STATE_UPDATED to ensure the session is not assumed
1905 * to be ready and to also allow the app to close it prior to vpp's
1906 * connected reply. */
1907 session->session_state = VCL_STATE_UPDATED;
1908 return VPPCOM_EINPROGRESS;
1912 * Wait for reply from vpp if blocking
1914 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1915 vcm->cfg.session_timeout);
1917 session = vcl_session_get (wrk, session_index);
1918 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1919 session->vpp_handle, rv ? "failed" : "succeeded");
1925 vppcom_session_stream_connect (uint32_t session_handle,
1926 uint32_t parent_session_handle)
1928 vcl_worker_t *wrk = vcl_worker_get_current ();
1929 vcl_session_t *session, *parent_session;
1930 u32 session_index, parent_session_index;
1933 session = vcl_session_get_w_handle (wrk, session_handle);
1935 return VPPCOM_EBADFD;
1936 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1937 if (!parent_session)
1938 return VPPCOM_EBADFD;
1940 session_index = session->session_index;
1941 parent_session_index = parent_session->session_index;
1942 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1944 VDBG (0, "ERROR: cannot connect epoll session %u!",
1945 session->session_index);
1946 return VPPCOM_EBADFD;
1949 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1951 VDBG (0, "session handle %u [0x%llx]: session already "
1952 "connected to session %u [0x%llx] proto %s, state 0x%x (%s)",
1953 session_handle, session->vpp_handle,
1954 parent_session_handle, parent_session->vpp_handle,
1955 vppcom_proto_str (session->session_type), session->session_state,
1956 vppcom_session_state_str (session->session_state));
1960 /* Connect to quic session specifics */
1961 session->transport.is_ip4 = parent_session->transport.is_ip4;
1962 session->transport.rmt_ip.ip4.as_u32 = (uint32_t) 1;
1963 session->transport.rmt_port = 0;
1964 session->parent_handle = parent_session->vpp_handle;
1966 VDBG (0, "session handle %u: connecting to session %u [0x%llx]",
1967 session_handle, parent_session_handle, parent_session->vpp_handle);
1970 * Send connect request and wait for reply from vpp
1972 vcl_send_session_connect (wrk, session);
1973 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1974 vcm->cfg.session_timeout);
1976 session->listener_index = parent_session_index;
1977 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1979 parent_session->n_accepted_sessions++;
1981 session = vcl_session_get (wrk, session_index);
1982 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1983 session->vpp_handle, rv ? "failed" : "succeeded");
1989 vppcom_session_read_internal (uint32_t session_handle, void *buf, int n,
1992 vcl_worker_t *wrk = vcl_worker_get_current ();
1993 int rv, n_read = 0, is_nonblocking;
1994 vcl_session_t *s = 0;
1995 svm_fifo_t *rx_fifo;
2000 if (PREDICT_FALSE (!buf))
2001 return VPPCOM_EFAULT;
2003 s = vcl_session_get_w_handle (wrk, session_handle);
2004 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2005 return VPPCOM_EBADFD;
2007 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2009 VDBG (0, "session %u[0x%llx] is not open! state 0x%x (%s)",
2010 s->session_index, s->vpp_handle, s->session_state,
2011 vppcom_session_state_str (s->session_state));
2012 return vcl_session_closed_error (s);
2015 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_RD_SHUTDOWN))
2017 /* Vpp would ack the incoming data and enqueue it for reading.
2018 * So even if SHUT_RD is set, we can still read() the data if
2019 * the session is ready.
2021 if (!vcl_session_read_ready (s))
2027 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2028 is_ct = vcl_session_is_ct (s);
2029 mq = wrk->app_event_queue;
2030 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
2031 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2033 if (svm_fifo_is_empty_cons (rx_fifo))
2037 if (vcl_session_is_closing (s))
2038 return vcl_session_closing_error (s);
2040 svm_fifo_unset_event (s->rx_fifo);
2041 svm_fifo_unset_event (rx_fifo);
2042 return VPPCOM_EWOULDBLOCK;
2044 while (svm_fifo_is_empty_cons (rx_fifo))
2046 if (vcl_session_is_closing (s))
2047 return vcl_session_closing_error (s);
2050 svm_fifo_unset_event (s->rx_fifo);
2051 svm_fifo_unset_event (rx_fifo);
2053 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2054 vcl_worker_flush_mq_events (wrk);
2061 rv = app_recv_dgram_raw (rx_fifo, buf, n, &s->transport, 0, peek);
2063 rv = app_recv_stream_raw (rx_fifo, buf, n, 0, peek);
2072 if (svm_fifo_is_empty_cons (rx_fifo))
2075 svm_fifo_unset_event (s->rx_fifo);
2076 svm_fifo_unset_event (rx_fifo);
2077 if (!svm_fifo_is_empty_cons (rx_fifo)
2078 && svm_fifo_set_event (rx_fifo) && is_nonblocking)
2080 vec_add2 (wrk->unhandled_evts_vector, e, 1);
2081 e->event_type = SESSION_IO_EVT_RX;
2082 e->session_index = s->session_index;
2085 else if (PREDICT_FALSE (rv < n && !s->is_dgram))
2087 /* More data enqueued while reading. Try to drain it
2088 * or fill the buffer. Avoid doing that for dgrams */
2094 if (PREDICT_FALSE (svm_fifo_needs_deq_ntf (rx_fifo, n_read)))
2096 svm_fifo_clear_deq_ntf (rx_fifo);
2097 app_send_io_evt_to_vpp (s->vpp_evt_q,
2098 s->rx_fifo->shr->master_session_index,
2099 SESSION_IO_EVT_RX, SVM_Q_WAIT);
2102 VDBG (2, "session %u[0x%llx]: read %d bytes from (%p)", s->session_index,
2103 s->vpp_handle, n_read, rx_fifo);
2109 vppcom_session_read (uint32_t session_handle, void *buf, size_t n)
2111 return (vppcom_session_read_internal (session_handle, buf, n, 0));
2115 vppcom_session_peek (uint32_t session_handle, void *buf, int n)
2117 return (vppcom_session_read_internal (session_handle, buf, n, 1));
2121 vppcom_session_read_segments (uint32_t session_handle,
2122 vppcom_data_segment_t * ds, uint32_t n_segments,
2125 vcl_worker_t *wrk = vcl_worker_get_current ();
2126 int n_read = 0, is_nonblocking;
2127 vcl_session_t *s = 0;
2128 svm_fifo_t *rx_fifo;
2132 s = vcl_session_get_w_handle (wrk, session_handle);
2133 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2134 return VPPCOM_EBADFD;
2136 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2137 return vcl_session_closed_error (s);
2139 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2140 is_ct = vcl_session_is_ct (s);
2141 mq = wrk->app_event_queue;
2142 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
2143 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2145 if (svm_fifo_is_empty_cons (rx_fifo))
2150 svm_fifo_unset_event (s->rx_fifo);
2151 svm_fifo_unset_event (rx_fifo);
2152 return VPPCOM_EWOULDBLOCK;
2154 while (svm_fifo_is_empty_cons (rx_fifo))
2156 if (vcl_session_is_closing (s))
2157 return vcl_session_closing_error (s);
2160 svm_fifo_unset_event (s->rx_fifo);
2161 svm_fifo_unset_event (rx_fifo);
2163 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2164 vcl_worker_flush_mq_events (wrk);
2168 n_read = svm_fifo_segments (rx_fifo, s->rx_bytes_pending,
2169 (svm_fifo_seg_t *) ds, n_segments, max_bytes);
2171 return VPPCOM_EAGAIN;
2173 if (svm_fifo_max_dequeue_cons (rx_fifo) == n_read)
2176 svm_fifo_unset_event (s->rx_fifo);
2177 svm_fifo_unset_event (rx_fifo);
2178 if (svm_fifo_max_dequeue_cons (rx_fifo) != n_read
2179 && svm_fifo_set_event (rx_fifo)
2180 && vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
2183 vec_add2 (wrk->unhandled_evts_vector, e, 1);
2184 e->event_type = SESSION_IO_EVT_RX;
2185 e->session_index = s->session_index;
2189 s->rx_bytes_pending += n_read;
2194 vppcom_session_free_segments (uint32_t session_handle, uint32_t n_bytes)
2196 vcl_worker_t *wrk = vcl_worker_get_current ();
2200 s = vcl_session_get_w_handle (wrk, session_handle);
2201 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2204 is_ct = vcl_session_is_ct (s);
2205 svm_fifo_dequeue_drop (is_ct ? s->ct_rx_fifo : s->rx_fifo, n_bytes);
2207 ASSERT (s->rx_bytes_pending >= n_bytes);
2208 s->rx_bytes_pending -= n_bytes;
2212 vcl_fifo_is_writeable (svm_fifo_t * f, u32 len, u8 is_dgram)
2214 u32 max_enq = svm_fifo_max_enqueue_prod (f);
2216 return max_enq >= (sizeof (session_dgram_hdr_t) + len);
2222 vppcom_session_write_inline (vcl_worker_t * wrk, vcl_session_t * s, void *buf,
2223 size_t n, u8 is_flush, u8 is_dgram)
2225 int n_write, is_nonblocking;
2226 session_evt_type_t et;
2227 svm_fifo_t *tx_fifo;
2231 /* Accept zero length writes but just return */
2232 if (PREDICT_FALSE (!n))
2235 if (PREDICT_FALSE (!buf))
2236 return VPPCOM_EFAULT;
2238 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2240 VDBG (0, "ERROR: session %u [0x%llx]: cannot write to an epoll"
2241 " session!", s->session_index, s->vpp_handle);
2242 return VPPCOM_EBADFD;
2245 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2247 VDBG (1, "session %u [0x%llx]: is not open! state 0x%x (%s)",
2248 s->session_index, s->vpp_handle, s->session_state,
2249 vppcom_session_state_str (s->session_state));
2250 return vcl_session_closed_error (s);;
2253 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_WR_SHUTDOWN))
2255 VDBG (1, "session %u [0x%llx]: is shutdown! state 0x%x (%s)",
2256 s->session_index, s->vpp_handle, s->session_state,
2257 vppcom_session_state_str (s->session_state));
2258 return VPPCOM_EPIPE;
2261 is_ct = vcl_session_is_ct (s);
2262 tx_fifo = is_ct ? s->ct_tx_fifo : s->tx_fifo;
2263 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2265 mq = wrk->app_event_queue;
2266 if (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2270 return VPPCOM_EWOULDBLOCK;
2272 while (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2274 svm_fifo_add_want_deq_ntf (tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
2275 if (vcl_session_is_closing (s))
2276 return vcl_session_closing_error (s);
2278 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2279 vcl_worker_flush_mq_events (wrk);
2283 et = SESSION_IO_EVT_TX;
2284 if (is_flush && !is_ct)
2285 et = SESSION_IO_EVT_TX_FLUSH;
2288 n_write = app_send_dgram_raw (tx_fifo, &s->transport,
2289 s->vpp_evt_q, buf, n, et,
2290 0 /* do_evt */ , SVM_Q_WAIT);
2292 n_write = app_send_stream_raw (tx_fifo, s->vpp_evt_q, buf, n, et,
2293 0 /* do_evt */ , SVM_Q_WAIT);
2295 if (svm_fifo_set_event (s->tx_fifo))
2296 app_send_io_evt_to_vpp (
2297 s->vpp_evt_q, s->tx_fifo->shr->master_session_index, et, SVM_Q_WAIT);
2299 /* The underlying fifo segment can run out of memory */
2300 if (PREDICT_FALSE (n_write < 0))
2301 return VPPCOM_EAGAIN;
2303 VDBG (2, "session %u [0x%llx]: wrote %d bytes", s->session_index,
2304 s->vpp_handle, n_write);
2310 vppcom_session_write (uint32_t session_handle, void *buf, size_t n)
2312 vcl_worker_t *wrk = vcl_worker_get_current ();
2315 s = vcl_session_get_w_handle (wrk, session_handle);
2316 if (PREDICT_FALSE (!s))
2317 return VPPCOM_EBADFD;
2319 return vppcom_session_write_inline (wrk, s, buf, n,
2320 0 /* is_flush */ , s->is_dgram ? 1 : 0);
2324 vppcom_session_write_msg (uint32_t session_handle, void *buf, size_t n)
2326 vcl_worker_t *wrk = vcl_worker_get_current ();
2329 s = vcl_session_get_w_handle (wrk, session_handle);
2330 if (PREDICT_FALSE (!s))
2331 return VPPCOM_EBADFD;
2333 return vppcom_session_write_inline (wrk, s, buf, n,
2334 1 /* is_flush */ , s->is_dgram ? 1 : 0);
2337 #define vcl_fifo_rx_evt_valid_or_break(_s) \
2338 if (PREDICT_FALSE (!_s->rx_fifo)) \
2340 if (PREDICT_FALSE (svm_fifo_is_empty (_s->rx_fifo))) \
2342 if (!vcl_session_is_ct (_s)) \
2344 svm_fifo_unset_event (_s->rx_fifo); \
2345 if (svm_fifo_is_empty (_s->rx_fifo)) \
2348 else if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2350 svm_fifo_unset_event (_s->rx_fifo); /* rx evts on actual fifo*/ \
2351 if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2357 vcl_select_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2358 unsigned long n_bits, unsigned long *read_map,
2359 unsigned long *write_map,
2360 unsigned long *except_map, u32 * bits_set)
2362 session_disconnected_msg_t *disconnected_msg;
2363 session_connected_msg_t *connected_msg;
2367 switch (e->event_type)
2369 case SESSION_IO_EVT_RX:
2370 sid = e->session_index;
2371 s = vcl_session_get (wrk, sid);
2372 if (!s || !vcl_session_is_open (s))
2374 vcl_fifo_rx_evt_valid_or_break (s);
2375 if (sid < n_bits && read_map)
2377 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2381 case SESSION_IO_EVT_TX:
2382 sid = e->session_index;
2383 s = vcl_session_get (wrk, sid);
2384 if (!s || !vcl_session_is_open (s))
2386 if (sid < n_bits && write_map)
2388 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2392 case SESSION_CTRL_EVT_ACCEPTED:
2394 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
2396 s = vcl_session_get (wrk, e->session_index);
2399 sid = s->session_index;
2400 if (sid < n_bits && read_map)
2402 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2406 case SESSION_CTRL_EVT_CONNECTED:
2409 connected_msg = (session_connected_msg_t *) e->data;
2410 sid = vcl_session_connected_handler (wrk, connected_msg);
2413 sid = e->session_index;
2414 if (sid == VCL_INVALID_SESSION_INDEX)
2416 if (sid < n_bits && write_map)
2418 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2422 case SESSION_CTRL_EVT_DISCONNECTED:
2423 disconnected_msg = (session_disconnected_msg_t *) e->data;
2424 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
2427 sid = s->session_index;
2428 if (sid < n_bits && except_map)
2430 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2434 case SESSION_CTRL_EVT_RESET:
2435 sid = vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
2436 if (sid < n_bits && except_map)
2438 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2442 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
2443 vcl_session_unlisten_reply_handler (wrk, e->data);
2445 case SESSION_CTRL_EVT_MIGRATED:
2446 vcl_session_migrated_handler (wrk, e->data);
2448 case SESSION_CTRL_EVT_CLEANUP:
2449 vcl_session_cleanup_handler (wrk, e->data);
2451 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
2452 vcl_session_worker_update_reply_handler (wrk, e->data);
2454 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
2455 vcl_session_req_worker_update_handler (wrk, e->data);
2457 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
2458 vcl_session_app_add_segment_handler (wrk, e->data);
2460 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
2461 vcl_session_app_del_segment_handler (wrk, e->data);
2463 case SESSION_CTRL_EVT_APP_WRK_RPC:
2464 vcl_worker_rpc_handler (wrk, e->data);
2467 clib_warning ("unhandled: %u", e->event_type);
2473 vcl_select_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
2474 unsigned long n_bits, unsigned long *read_map,
2475 unsigned long *write_map, unsigned long *except_map,
2476 double time_to_wait, u32 * bits_set)
2478 svm_msg_q_msg_t *msg;
2482 if (svm_msg_q_is_empty (mq))
2489 else if (time_to_wait < 0)
2490 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2493 if (svm_msg_q_timedwait (mq, time_to_wait))
2497 vcl_mq_dequeue_batch (wrk, mq, ~0);
2499 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
2501 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
2502 e = svm_msg_q_msg_data (mq, msg);
2503 vcl_select_handle_mq_event (wrk, e, n_bits, read_map, write_map,
2504 except_map, bits_set);
2505 svm_msg_q_free_msg (mq, msg);
2507 vec_reset_length (wrk->mq_msg_vector);
2508 vcl_handle_pending_wrk_updates (wrk);
2513 vppcom_select_condvar (vcl_worker_t * wrk, int n_bits,
2514 vcl_si_set * read_map, vcl_si_set * write_map,
2515 vcl_si_set * except_map, double time_to_wait,
2518 double wait = 0, start = 0;
2522 wait = time_to_wait;
2523 start = clib_time_now (&wrk->clib_time);
2528 vcl_select_handle_mq (wrk, wrk->app_event_queue, n_bits, read_map,
2529 write_map, except_map, wait, bits_set);
2535 wait = wait - (clib_time_now (&wrk->clib_time) - start);
2543 vppcom_select_eventfd (vcl_worker_t * wrk, int n_bits,
2544 vcl_si_set * read_map, vcl_si_set * write_map,
2545 vcl_si_set * except_map, double time_to_wait,
2548 vcl_mq_evt_conn_t *mqc;
2549 int __clib_unused n_read;
2553 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
2554 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
2555 vec_len (wrk->mq_events), time_to_wait);
2556 for (i = 0; i < n_mq_evts; i++)
2558 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
2559 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
2560 vcl_select_handle_mq (wrk, mqc->mq, n_bits, read_map, write_map,
2561 except_map, 0, bits_set);
2564 return (n_mq_evts > 0 ? (int) *bits_set : 0);
2568 vppcom_select (int n_bits, vcl_si_set * read_map, vcl_si_set * write_map,
2569 vcl_si_set * except_map, double time_to_wait)
2571 u32 sid, minbits = clib_max (n_bits, BITS (uword)), bits_set = 0;
2572 vcl_worker_t *wrk = vcl_worker_get_current ();
2573 vcl_session_t *s = 0;
2576 if (n_bits && read_map)
2578 clib_bitmap_validate (wrk->rd_bitmap, minbits);
2579 clib_memcpy_fast (wrk->rd_bitmap, read_map,
2580 vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2581 memset (read_map, 0, vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2583 if (n_bits && write_map)
2585 clib_bitmap_validate (wrk->wr_bitmap, minbits);
2586 clib_memcpy_fast (wrk->wr_bitmap, write_map,
2587 vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2588 memset (write_map, 0, vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2590 if (n_bits && except_map)
2592 clib_bitmap_validate (wrk->ex_bitmap, minbits);
2593 clib_memcpy_fast (wrk->ex_bitmap, except_map,
2594 vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2595 memset (except_map, 0, vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2604 clib_bitmap_foreach (sid, wrk->wr_bitmap)
2606 if (!(s = vcl_session_get (wrk, sid)))
2608 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2613 if (vcl_session_write_ready (s))
2615 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2620 svm_fifo_t *txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2621 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF);
2629 clib_bitmap_foreach (sid, wrk->rd_bitmap)
2631 if (!(s = vcl_session_get (wrk, sid)))
2633 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2638 if (vcl_session_read_ready (s))
2640 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2647 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
2649 vcl_select_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i], n_bits,
2650 read_map, write_map, except_map, &bits_set);
2652 vec_reset_length (wrk->unhandled_evts_vector);
2654 if (vcm->cfg.use_mq_eventfd)
2655 vppcom_select_eventfd (wrk, n_bits, read_map, write_map, except_map,
2656 time_to_wait, &bits_set);
2658 vppcom_select_condvar (wrk, n_bits, read_map, write_map, except_map,
2659 time_to_wait, &bits_set);
2665 vep_verify_epoll_chain (vcl_worker_t * wrk, u32 vep_handle)
2667 vppcom_epoll_t *vep;
2668 u32 sh = vep_handle;
2671 if (VPPCOM_DEBUG <= 2)
2674 s = vcl_session_get_w_handle (wrk, vep_handle);
2675 if (PREDICT_FALSE (!s))
2677 VDBG (0, "ERROR: Invalid vep_sh (%u)!", vep_handle);
2680 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP)))
2682 VDBG (0, "ERROR: vep_sh (%u) is not a vep!", vep_handle);
2686 VDBG (0, "vep_sh (%u): Dumping epoll chain\n"
2689 " is_vep_session = %u\n"
2690 " next_sh = 0x%x (%u)\n"
2691 "}\n", vep_handle, s->flags & VCL_SESSION_F_IS_VEP,
2692 s->flags & VCL_SESSION_F_IS_VEP_SESSION, vep->next_sh, vep->next_sh);
2694 for (sh = vep->next_sh; sh != ~0; sh = vep->next_sh)
2696 s = vcl_session_get_w_handle (wrk, sh);
2697 if (PREDICT_FALSE (!s))
2699 VDBG (0, "ERROR: Invalid sh (%u)!", sh);
2702 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2704 VDBG (0, "ERROR: sh (%u) is a vep!", vep_handle);
2706 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2708 VDBG (0, "ERROR: sh (%u) is not a vep session handle!", sh);
2712 if (PREDICT_FALSE (vep->vep_sh != vep_handle))
2713 VDBG (0, "ERROR: session (%u) vep_sh (%u) != vep_sh (%u)!",
2714 sh, s->vep.vep_sh, vep_handle);
2715 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2717 VDBG (0, "vep_sh[%u]: sh 0x%x (%u)\n"
2719 " next_sh = 0x%x (%u)\n"
2720 " prev_sh = 0x%x (%u)\n"
2721 " vep_sh = 0x%x (%u)\n"
2722 " ev.events = 0x%x\n"
2723 " ev.data.u64 = 0x%llx\n"
2726 vep_handle, sh, sh, vep->next_sh, vep->next_sh, vep->prev_sh,
2727 vep->prev_sh, vep->vep_sh, vep->vep_sh, vep->ev.events,
2728 vep->ev.data.u64, vep->et_mask);
2733 VDBG (0, "vep_sh (%u): Dump complete!\n", vep_handle);
2737 vppcom_epoll_create (void)
2739 vcl_worker_t *wrk = vcl_worker_get_current ();
2740 vcl_session_t *vep_session;
2742 vep_session = vcl_session_alloc (wrk);
2744 vep_session->flags |= VCL_SESSION_F_IS_VEP;
2745 vep_session->vep.vep_sh = ~0;
2746 vep_session->vep.next_sh = ~0;
2747 vep_session->vep.prev_sh = ~0;
2748 vep_session->vpp_handle = ~0;
2750 vcl_evt (VCL_EVT_EPOLL_CREATE, vep_session, vep_session->session_index);
2751 VDBG (0, "Created vep_idx %u", vep_session->session_index);
2753 return vcl_session_handle (vep_session);
2757 vppcom_epoll_ctl (uint32_t vep_handle, int op, uint32_t session_handle,
2758 struct epoll_event *event)
2760 vcl_worker_t *wrk = vcl_worker_get_current ();
2761 int rv = VPPCOM_OK, add_evt = 0;
2762 vcl_session_t *vep_session;
2766 if (vep_handle == session_handle)
2768 VDBG (0, "vep_sh == session handle (%u)!", vep_handle);
2769 return VPPCOM_EINVAL;
2772 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
2773 if (PREDICT_FALSE (!vep_session))
2775 VDBG (0, "Invalid vep_sh (%u)!", vep_handle);
2776 return VPPCOM_EBADFD;
2778 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
2780 VDBG (0, "vep_sh (%u) is not a vep!", vep_handle);
2781 return VPPCOM_EINVAL;
2784 ASSERT (vep_session->vep.vep_sh == ~0);
2785 ASSERT (vep_session->vep.prev_sh == ~0);
2787 s = vcl_session_get_w_handle (wrk, session_handle);
2788 if (PREDICT_FALSE (!s))
2790 VDBG (0, "Invalid session_handle (%u)!", session_handle);
2791 return VPPCOM_EBADFD;
2793 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2795 VDBG (0, "session_handle (%u) is a vep!", vep_handle);
2796 return VPPCOM_EINVAL;
2802 if (PREDICT_FALSE (!event))
2804 VDBG (0, "EPOLL_CTL_ADD: NULL pointer to epoll_event structure!");
2805 return VPPCOM_EINVAL;
2807 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2809 VDBG (0, "EPOLL_CTL_ADD: %u already epolled!", s->session_index);
2813 if (vep_session->vep.next_sh != ~0)
2815 vcl_session_t *next_session;
2816 next_session = vcl_session_get_w_handle (wrk,
2817 vep_session->vep.next_sh);
2818 if (PREDICT_FALSE (!next_session))
2820 VDBG (0, "EPOLL_CTL_ADD: Invalid vep.next_sh (%u) on "
2821 "vep_idx (%u)!", vep_session->vep.next_sh, vep_handle);
2822 return VPPCOM_EBADFD;
2824 ASSERT (next_session->vep.prev_sh == vep_handle);
2825 next_session->vep.prev_sh = session_handle;
2827 s->vep.next_sh = vep_session->vep.next_sh;
2828 s->vep.prev_sh = vep_handle;
2829 s->vep.vep_sh = vep_handle;
2830 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2831 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
2833 s->flags &= ~VCL_SESSION_F_IS_VEP;
2834 s->flags |= VCL_SESSION_F_IS_VEP_SESSION;
2835 vep_session->vep.next_sh = session_handle;
2837 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2838 if (txf && (event->events & EPOLLOUT))
2839 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2841 /* Generate EPOLLOUT if tx fifo not full */
2842 if ((event->events & EPOLLOUT) && (vcl_session_write_ready (s) > 0))
2844 session_event_t e = { 0 };
2845 e.event_type = SESSION_IO_EVT_TX;
2846 e.session_index = s->session_index;
2847 vec_add1 (wrk->unhandled_evts_vector, e);
2850 /* Generate EPOLLIN if rx fifo has data */
2851 if ((event->events & EPOLLIN) && (vcl_session_read_ready (s) > 0))
2853 session_event_t e = { 0 };
2854 e.event_type = SESSION_IO_EVT_RX;
2855 e.session_index = s->session_index;
2856 vec_add1 (wrk->unhandled_evts_vector, e);
2857 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2860 if (!add_evt && vcl_session_is_closing (s))
2862 session_event_t e = { 0 };
2863 if (s->session_state == VCL_STATE_VPP_CLOSING)
2864 e.event_type = SESSION_CTRL_EVT_DISCONNECTED;
2866 e.event_type = SESSION_CTRL_EVT_RESET;
2867 e.session_index = s->session_index;
2869 vec_add1 (wrk->unhandled_evts_vector, e);
2871 VDBG (1, "EPOLL_CTL_ADD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2872 vep_handle, session_handle, event->events, event->data.u64);
2873 vcl_evt (VCL_EVT_EPOLL_CTLADD, s, event->events, event->data.u64);
2877 if (PREDICT_FALSE (!event))
2879 VDBG (0, "EPOLL_CTL_MOD: NULL pointer to epoll_event structure!");
2883 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2885 VDBG (0, "sh %u EPOLL_CTL_MOD: not a vep session!", session_handle);
2889 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2891 VDBG (0, "EPOLL_CTL_MOD: sh %u vep_sh (%u) != vep_sh (%u)!",
2892 session_handle, s->vep.vep_sh, vep_handle);
2897 /* Generate EPOLLOUT if session write ready nd event was not on */
2898 if ((event->events & EPOLLOUT) && !(s->vep.ev.events & EPOLLOUT) &&
2899 (vcl_session_write_ready (s) > 0))
2901 session_event_t e = { 0 };
2902 e.event_type = SESSION_IO_EVT_TX;
2903 e.session_index = s->session_index;
2904 vec_add1 (wrk->unhandled_evts_vector, e);
2906 /* Generate EPOLLIN if session read ready and event was not on */
2907 if ((event->events & EPOLLIN) && !(s->vep.ev.events & EPOLLIN) &&
2908 (vcl_session_read_ready (s) > 0))
2910 session_event_t e = { 0 };
2911 e.event_type = SESSION_IO_EVT_RX;
2912 e.session_index = s->session_index;
2913 vec_add1 (wrk->unhandled_evts_vector, e);
2914 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2916 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2918 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2921 if (event->events & EPOLLOUT)
2922 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2924 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2926 VDBG (1, "EPOLL_CTL_MOD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2927 vep_handle, session_handle, event->events, event->data.u64);
2931 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2933 VDBG (0, "EPOLL_CTL_DEL: %u not a vep session!", session_handle);
2937 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2939 VDBG (0, "EPOLL_CTL_DEL: sh %u vep_sh (%u) != vep_sh (%u)!",
2940 session_handle, s->vep.vep_sh, vep_handle);
2945 if (s->vep.prev_sh == vep_handle)
2946 vep_session->vep.next_sh = s->vep.next_sh;
2949 vcl_session_t *prev_session;
2950 prev_session = vcl_session_get_w_handle (wrk, s->vep.prev_sh);
2951 if (PREDICT_FALSE (!prev_session))
2953 VDBG (0, "EPOLL_CTL_DEL: Invalid prev_sh (%u) on sh (%u)!",
2954 s->vep.prev_sh, session_handle);
2955 return VPPCOM_EBADFD;
2957 ASSERT (prev_session->vep.next_sh == session_handle);
2958 prev_session->vep.next_sh = s->vep.next_sh;
2960 if (s->vep.next_sh != ~0)
2962 vcl_session_t *next_session;
2963 next_session = vcl_session_get_w_handle (wrk, s->vep.next_sh);
2964 if (PREDICT_FALSE (!next_session))
2966 VDBG (0, "EPOLL_CTL_DEL: Invalid next_sh (%u) on sh (%u)!",
2967 s->vep.next_sh, session_handle);
2968 return VPPCOM_EBADFD;
2970 ASSERT (next_session->vep.prev_sh == session_handle);
2971 next_session->vep.prev_sh = s->vep.prev_sh;
2974 if (s->vep.lt_next != VCL_INVALID_SESSION_INDEX)
2975 vcl_epoll_lt_del (wrk, s);
2977 memset (&s->vep, 0, sizeof (s->vep));
2978 s->vep.next_sh = ~0;
2979 s->vep.prev_sh = ~0;
2981 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
2982 s->flags &= ~VCL_SESSION_F_IS_VEP_SESSION;
2984 if (vcl_session_is_open (s))
2986 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2988 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2991 VDBG (1, "EPOLL_CTL_DEL: vep_idx %u, sh %u!", vep_handle,
2993 vcl_evt (VCL_EVT_EPOLL_CTLDEL, s, vep_sh);
2997 VDBG (0, "Invalid operation (%d)!", op);
3001 vep_verify_epoll_chain (wrk, vep_handle);
3008 vcl_epoll_wait_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
3009 struct epoll_event *events, u32 * num_ev)
3011 session_disconnected_msg_t *disconnected_msg;
3012 session_connected_msg_t *connected_msg;
3013 u32 sid = ~0, session_events;
3014 u64 session_evt_data = ~0;
3018 switch (e->event_type)
3020 case SESSION_IO_EVT_RX:
3021 sid = e->session_index;
3022 s = vcl_session_get (wrk, sid);
3023 if (vcl_session_is_closed (s))
3025 vcl_fifo_rx_evt_valid_or_break (s);
3026 session_events = s->vep.ev.events;
3027 if (!(EPOLLIN & s->vep.ev.events) ||
3028 (s->flags & VCL_SESSION_F_HAS_RX_EVT) ||
3029 (s->vep.lt_next != VCL_INVALID_SESSION_INDEX))
3032 events[*num_ev].events = EPOLLIN;
3033 session_evt_data = s->vep.ev.data.u64;
3034 s->flags |= VCL_SESSION_F_HAS_RX_EVT;
3036 case SESSION_IO_EVT_TX:
3037 sid = e->session_index;
3038 s = vcl_session_get (wrk, sid);
3039 if (vcl_session_is_closed (s))
3041 session_events = s->vep.ev.events;
3042 if (!(EPOLLOUT & session_events))
3045 events[*num_ev].events = EPOLLOUT;
3046 session_evt_data = s->vep.ev.data.u64;
3047 svm_fifo_reset_has_deq_ntf (vcl_session_is_ct (s) ?
3048 s->ct_tx_fifo : s->tx_fifo);
3050 case SESSION_CTRL_EVT_ACCEPTED:
3052 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
3054 s = vcl_session_get (wrk, e->session_index);
3057 session_events = s->vep.ev.events;
3058 sid = s->session_index;
3059 if (!(EPOLLIN & session_events) ||
3060 (s->vep.lt_next != VCL_INVALID_SESSION_INDEX))
3063 events[*num_ev].events = EPOLLIN;
3064 session_evt_data = s->vep.ev.data.u64;
3066 case SESSION_CTRL_EVT_CONNECTED:
3069 connected_msg = (session_connected_msg_t *) e->data;
3070 sid = vcl_session_connected_handler (wrk, connected_msg);
3073 sid = e->session_index;
3074 s = vcl_session_get (wrk, sid);
3075 if (vcl_session_is_closed (s))
3077 session_events = s->vep.ev.events;
3078 /* Generate EPOLLOUT because there's no connected event */
3079 if (!(EPOLLOUT & session_events))
3082 events[*num_ev].events = EPOLLOUT;
3083 session_evt_data = s->vep.ev.data.u64;
3084 if (s->session_state == VCL_STATE_DETACHED)
3085 events[*num_ev].events |= EPOLLHUP;
3087 case SESSION_CTRL_EVT_DISCONNECTED:
3090 disconnected_msg = (session_disconnected_msg_t *) e->data;
3091 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
3095 s = vcl_session_get (wrk, e->session_index);
3097 if (vcl_session_is_closed (s) ||
3098 !(s->flags & VCL_SESSION_F_IS_VEP_SESSION))
3100 sid = s->session_index;
3101 session_events = s->vep.ev.events;
3103 if (EPOLLRDHUP & session_events)
3105 /* If app can distinguish between RDHUP and HUP,
3106 * we make finer control */
3107 events[*num_ev].events = EPOLLRDHUP;
3108 if (s->flags & VCL_SESSION_F_WR_SHUTDOWN)
3110 events[*num_ev].events |= EPOLLHUP;
3115 events[*num_ev].events = EPOLLHUP;
3117 session_evt_data = s->vep.ev.data.u64;
3120 case SESSION_CTRL_EVT_RESET:
3122 sid = vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
3124 sid = e->session_index;
3125 s = vcl_session_get (wrk, sid);
3126 if (vcl_session_is_closed (s) ||
3127 !(s->flags & VCL_SESSION_F_IS_VEP_SESSION))
3129 session_events = s->vep.ev.events;
3131 events[*num_ev].events = EPOLLHUP | EPOLLRDHUP;
3132 session_evt_data = s->vep.ev.data.u64;
3134 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
3135 vcl_session_unlisten_reply_handler (wrk, e->data);
3137 case SESSION_CTRL_EVT_MIGRATED:
3138 vcl_session_migrated_handler (wrk, e->data);
3140 case SESSION_CTRL_EVT_CLEANUP:
3141 vcl_session_cleanup_handler (wrk, e->data);
3143 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
3144 vcl_session_req_worker_update_handler (wrk, e->data);
3146 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
3147 vcl_session_worker_update_reply_handler (wrk, e->data);
3149 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
3150 vcl_session_app_add_segment_handler (wrk, e->data);
3152 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
3153 vcl_session_app_del_segment_handler (wrk, e->data);
3155 case SESSION_CTRL_EVT_APP_WRK_RPC:
3156 vcl_worker_rpc_handler (wrk, e->data);
3159 VDBG (0, "unhandled: %u", e->event_type);
3165 events[*num_ev].data.u64 = session_evt_data;
3166 if (EPOLLONESHOT & session_events)
3168 s = vcl_session_get (wrk, sid);
3169 s->vep.ev.events = 0;
3171 else if (!(EPOLLET & session_events))
3173 s = vcl_session_get (wrk, sid);
3174 if (s->vep.lt_next == VCL_INVALID_SESSION_INDEX)
3175 vcl_epoll_lt_add (wrk, s);
3182 vcl_epoll_wait_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
3183 struct epoll_event *events, u32 maxevents,
3184 double wait_for_time, u32 * num_ev)
3186 svm_msg_q_msg_t *msg;
3190 if (vec_len (wrk->mq_msg_vector) && svm_msg_q_is_empty (mq))
3191 goto handle_dequeued;
3193 if (svm_msg_q_is_empty (mq))
3197 else if (wait_for_time < 0)
3198 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
3201 if (svm_msg_q_timedwait (mq, wait_for_time / 1e3))
3205 ASSERT (maxevents > *num_ev);
3206 vcl_mq_dequeue_batch (wrk, mq, ~0);
3209 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
3211 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
3212 e = svm_msg_q_msg_data (mq, msg);
3213 if (*num_ev < maxevents)
3214 vcl_epoll_wait_handle_mq_event (wrk, e, events, num_ev);
3216 vcl_handle_mq_event (wrk, e);
3217 svm_msg_q_free_msg (mq, msg);
3219 vec_reset_length (wrk->mq_msg_vector);
3220 vcl_handle_pending_wrk_updates (wrk);
3225 vppcom_epoll_wait_condvar (vcl_worker_t *wrk, struct epoll_event *events,
3226 int maxevents, u32 n_evts, double timeout_ms)
3233 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3238 vcl_epoll_wait_handle_mq (wrk, wrk->app_event_queue, events, maxevents,
3239 timeout_ms, &n_evts);
3240 if (n_evts || !timeout_ms)
3243 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3249 vppcom_epoll_wait_eventfd (vcl_worker_t *wrk, struct epoll_event *events,
3250 int maxevents, u32 n_evts, double timeout_ms)
3252 int __clib_unused n_read;
3253 vcl_mq_evt_conn_t *mqc;
3258 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
3262 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3267 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
3268 vec_len (wrk->mq_events), timeout_ms);
3271 VDBG (0, "epoll_wait error %u", errno);
3275 for (i = 0; i < n_mq_evts; i++)
3277 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
3278 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
3279 vcl_epoll_wait_handle_mq (wrk, mqc->mq, events, maxevents, 0,
3283 if (n_evts || !timeout_ms)
3286 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3292 vcl_epoll_wait_handle_lt (vcl_worker_t *wrk, struct epoll_event *events,
3293 int maxevents, u32 *n_evts)
3295 u32 add_event = 0, next;
3300 ASSERT (wrk->ep_lt_current != VCL_INVALID_SESSION_INDEX);
3301 if (*n_evts >= maxevents)
3304 next = wrk->ep_lt_current;
3307 s = vcl_session_get (wrk, next);
3308 next = s->vep.lt_next;
3310 if ((s->vep.ev.events & EPOLLIN) && (rv = vcl_session_read_ready (s)))
3313 events[*n_evts].events |= rv > 0 ? EPOLLIN : EPOLLHUP | EPOLLRDHUP;
3314 evt_data = s->vep.ev.data.u64;
3316 if ((s->vep.ev.events & EPOLLOUT) && (rv = vcl_session_write_ready (s)))
3319 events[*n_evts].events |= rv > 0 ? EPOLLOUT : EPOLLHUP | EPOLLRDHUP;
3320 evt_data = s->vep.ev.data.u64;
3322 if (!add_event && s->session_state > VCL_STATE_READY)
3325 events[*n_evts].events |= EPOLLHUP | EPOLLRDHUP;
3326 evt_data = s->vep.ev.data.u64;
3330 events[*n_evts].data.u64 = evt_data;
3333 if (EPOLLONESHOT & s->vep.ev.events)
3334 s->vep.ev.events = 0;
3335 if (*n_evts == maxevents)
3337 wrk->ep_lt_current = next;
3343 vcl_epoll_lt_del (wrk, s);
3344 if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX)
3348 while (next != wrk->ep_lt_current);
3352 vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
3353 int maxevents, double wait_for_time)
3355 vcl_worker_t *wrk = vcl_worker_get_current ();
3356 vcl_session_t *vep_session;
3360 if (PREDICT_FALSE (maxevents <= 0))
3362 VDBG (0, "ERROR: Invalid maxevents (%d)!", maxevents);
3363 return VPPCOM_EINVAL;
3366 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
3368 return VPPCOM_EBADFD;
3370 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
3372 VDBG (0, "ERROR: vep_idx (%u) is not a vep!", vep_handle);
3373 return VPPCOM_EINVAL;
3376 if (vec_len (wrk->unhandled_evts_vector))
3378 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
3380 vcl_epoll_wait_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i],
3382 if (n_evts == maxevents)
3384 vec_delete (wrk->unhandled_evts_vector, i + 1, 0);
3388 vec_reset_length (wrk->unhandled_evts_vector);
3391 if (PREDICT_FALSE (wrk->ep_lt_current != VCL_INVALID_SESSION_INDEX))
3392 vcl_epoll_wait_handle_lt (wrk, events, maxevents, &n_evts);
3394 /* Request to only drain unhandled */
3395 if ((int) wait_for_time == -2)
3399 if (vcm->cfg.use_mq_eventfd)
3400 n_evts = vppcom_epoll_wait_eventfd (wrk, events, maxevents, n_evts,
3403 n_evts = vppcom_epoll_wait_condvar (wrk, events, maxevents, n_evts,
3410 vppcom_session_attr (uint32_t session_handle, uint32_t op,
3411 void *buffer, uint32_t * buflen)
3413 vcl_worker_t *wrk = vcl_worker_get_current ();
3414 u32 *flags = buffer;
3415 vppcom_endpt_t *ep = buffer;
3416 transport_endpt_attr_t tea;
3417 vcl_session_t *session;
3420 session = vcl_session_get_w_handle (wrk, session_handle);
3422 return VPPCOM_EBADFD;
3426 case VPPCOM_ATTR_GET_NREAD:
3427 rv = vcl_session_read_ready (session);
3428 VDBG (2, "VPPCOM_ATTR_GET_NREAD: sh %u, nread = %d", session_handle,
3432 case VPPCOM_ATTR_GET_NWRITE:
3433 rv = vcl_session_write_ready (session);
3434 VDBG (2, "VPPCOM_ATTR_GET_NWRITE: sh %u, nwrite = %d", session_handle,
3438 case VPPCOM_ATTR_GET_FLAGS:
3439 if (PREDICT_TRUE (buffer && buflen && (*buflen >= sizeof (*flags))))
3443 (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK) ?
3445 *buflen = sizeof (*flags);
3446 VDBG (2, "VPPCOM_ATTR_GET_FLAGS: sh %u, flags = 0x%08x, "
3447 "is_nonblocking = %u", session_handle, *flags,
3448 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3454 case VPPCOM_ATTR_SET_FLAGS:
3455 if (PREDICT_TRUE (buffer && buflen && (*buflen == sizeof (*flags))))
3457 if (*flags & O_NONBLOCK)
3458 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
3460 vcl_session_clear_attr (session, VCL_SESS_ATTR_NONBLOCK);
3462 VDBG (2, "VPPCOM_ATTR_SET_FLAGS: sh %u, flags = 0x%08x,"
3463 " is_nonblocking = %u", session_handle, *flags,
3464 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3470 case VPPCOM_ATTR_GET_PEER_ADDR:
3471 if (PREDICT_TRUE (buffer && buflen &&
3472 (*buflen >= sizeof (*ep)) && ep->ip))
3474 ep->is_ip4 = session->transport.is_ip4;
3475 ep->port = session->transport.rmt_port;
3476 if (session->transport.is_ip4)
3477 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
3478 sizeof (ip4_address_t));
3480 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
3481 sizeof (ip6_address_t));
3482 *buflen = sizeof (*ep);
3483 VDBG (1, "VPPCOM_ATTR_GET_PEER_ADDR: sh %u, is_ip4 = %u, "
3484 "addr = %U, port %u", session_handle, ep->is_ip4,
3485 format_ip46_address, &session->transport.rmt_ip,
3486 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3487 clib_net_to_host_u16 (ep->port));
3493 case VPPCOM_ATTR_GET_LCL_ADDR:
3494 if (PREDICT_TRUE (buffer && buflen &&
3495 (*buflen >= sizeof (*ep)) && ep->ip))
3497 ep->is_ip4 = session->transport.is_ip4;
3498 ep->port = session->transport.lcl_port;
3499 if (session->transport.is_ip4)
3500 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip4,
3501 sizeof (ip4_address_t));
3503 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip6,
3504 sizeof (ip6_address_t));
3505 *buflen = sizeof (*ep);
3506 VDBG (1, "VPPCOM_ATTR_GET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3507 " port %d", session_handle, ep->is_ip4, format_ip46_address,
3508 &session->transport.lcl_ip,
3509 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3510 clib_net_to_host_u16 (ep->port));
3516 case VPPCOM_ATTR_SET_LCL_ADDR:
3517 if (PREDICT_TRUE (buffer && buflen &&
3518 (*buflen >= sizeof (*ep)) && ep->ip))
3520 session->transport.is_ip4 = ep->is_ip4;
3521 session->transport.lcl_port = ep->port;
3522 vcl_ip_copy_from_ep (&session->transport.lcl_ip, ep);
3523 *buflen = sizeof (*ep);
3524 VDBG (1, "VPPCOM_ATTR_SET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3525 " port %d", session_handle, ep->is_ip4, format_ip46_address,
3526 &session->transport.lcl_ip,
3527 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3528 clib_net_to_host_u16 (ep->port));
3534 case VPPCOM_ATTR_GET_LIBC_EPFD:
3535 rv = session->libc_epfd;
3536 VDBG (2, "VPPCOM_ATTR_GET_LIBC_EPFD: libc_epfd %d", rv);
3539 case VPPCOM_ATTR_SET_LIBC_EPFD:
3540 if (PREDICT_TRUE (buffer && buflen &&
3541 (*buflen == sizeof (session->libc_epfd))))
3543 session->libc_epfd = *(int *) buffer;
3544 *buflen = sizeof (session->libc_epfd);
3546 VDBG (2, "VPPCOM_ATTR_SET_LIBC_EPFD: libc_epfd %d, buflen %d",
3547 session->libc_epfd, *buflen);
3553 case VPPCOM_ATTR_GET_PROTOCOL:
3554 if (buffer && buflen && (*buflen >= sizeof (int)))
3556 *(int *) buffer = session->session_type;
3557 *buflen = sizeof (int);
3559 VDBG (2, "VPPCOM_ATTR_GET_PROTOCOL: %d (%s), buflen %d",
3560 *(int *) buffer, *(int *) buffer ? "UDP" : "TCP", *buflen);
3566 case VPPCOM_ATTR_GET_LISTEN:
3567 if (buffer && buflen && (*buflen >= sizeof (int)))
3569 *(int *) buffer = vcl_session_has_attr (session,
3570 VCL_SESS_ATTR_LISTEN);
3571 *buflen = sizeof (int);
3573 VDBG (2, "VPPCOM_ATTR_GET_LISTEN: %d, buflen %d", *(int *) buffer,
3580 case VPPCOM_ATTR_GET_ERROR:
3581 if (buffer && buflen && (*buflen >= sizeof (int)))
3583 *(int *) buffer = 0;
3584 *buflen = sizeof (int);
3586 VDBG (2, "VPPCOM_ATTR_GET_ERROR: %d, buflen %d, #VPP-TBD#",
3587 *(int *) buffer, *buflen);
3593 case VPPCOM_ATTR_GET_TX_FIFO_LEN:
3594 if (buffer && buflen && (*buflen >= sizeof (u32)))
3598 *(size_t *) buffer = (session->sndbuf_size ? session->sndbuf_size :
3600 svm_fifo_size (session->tx_fifo) :
3601 vcm->cfg.tx_fifo_size);
3602 *buflen = sizeof (u32);
3604 VDBG (2, "VPPCOM_ATTR_GET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3605 " #VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer,
3612 case VPPCOM_ATTR_SET_DSCP:
3613 if (buffer && buflen && (*buflen >= sizeof (u8)))
3615 session->dscp = *(u8 *) buffer;
3617 VDBG (2, "VPPCOM_ATTR_SET_DSCP: %u (0x%x), buflen %d,",
3618 *(u8 *) buffer, *(u8 *) buffer, *buflen);
3624 case VPPCOM_ATTR_SET_TX_FIFO_LEN:
3625 if (buffer && buflen && (*buflen == sizeof (u32)))
3628 session->sndbuf_size = *(u32 *) buffer;
3629 VDBG (2, "VPPCOM_ATTR_SET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3630 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3637 case VPPCOM_ATTR_GET_RX_FIFO_LEN:
3638 if (buffer && buflen && (*buflen >= sizeof (u32)))
3642 *(size_t *) buffer = (session->rcvbuf_size ? session->rcvbuf_size :
3644 svm_fifo_size (session->rx_fifo) :
3645 vcm->cfg.rx_fifo_size);
3646 *buflen = sizeof (u32);
3648 VDBG (2, "VPPCOM_ATTR_GET_RX_FIFO_LEN: %u (0x%x), buflen %d, "
3649 "#VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer, *buflen);
3655 case VPPCOM_ATTR_SET_RX_FIFO_LEN:
3656 if (buffer && buflen && (*buflen == sizeof (u32)))
3659 session->rcvbuf_size = *(u32 *) buffer;
3660 VDBG (2, "VPPCOM_ATTR_SET_RX_FIFO_LEN: %u (0x%x), buflen %d,"
3661 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3668 case VPPCOM_ATTR_GET_REUSEADDR:
3669 if (buffer && buflen && (*buflen >= sizeof (int)))
3672 *(int *) buffer = vcl_session_has_attr (session,
3673 VCL_SESS_ATTR_REUSEADDR);
3674 *buflen = sizeof (int);
3676 VDBG (2, "VPPCOM_ATTR_GET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3677 *(int *) buffer, *buflen);
3683 case VPPCOM_ATTR_SET_REUSEADDR:
3684 if (buffer && buflen && (*buflen == sizeof (int)) &&
3685 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3688 if (*(int *) buffer)
3689 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEADDR);
3691 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEADDR);
3693 VDBG (2, "VPPCOM_ATTR_SET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3694 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEADDR),
3701 case VPPCOM_ATTR_GET_REUSEPORT:
3702 if (buffer && buflen && (*buflen >= sizeof (int)))
3705 *(int *) buffer = vcl_session_has_attr (session,
3706 VCL_SESS_ATTR_REUSEPORT);
3707 *buflen = sizeof (int);
3709 VDBG (2, "VPPCOM_ATTR_GET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3710 *(int *) buffer, *buflen);
3716 case VPPCOM_ATTR_SET_REUSEPORT:
3717 if (buffer && buflen && (*buflen == sizeof (int)) &&
3718 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3721 if (*(int *) buffer)
3722 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEPORT);
3724 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEPORT);
3726 VDBG (2, "VPPCOM_ATTR_SET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3727 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEPORT),
3734 case VPPCOM_ATTR_GET_BROADCAST:
3735 if (buffer && buflen && (*buflen >= sizeof (int)))
3738 *(int *) buffer = vcl_session_has_attr (session,
3739 VCL_SESS_ATTR_BROADCAST);
3740 *buflen = sizeof (int);
3742 VDBG (2, "VPPCOM_ATTR_GET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3743 *(int *) buffer, *buflen);
3749 case VPPCOM_ATTR_SET_BROADCAST:
3750 if (buffer && buflen && (*buflen == sizeof (int)))
3753 if (*(int *) buffer)
3754 vcl_session_set_attr (session, VCL_SESS_ATTR_BROADCAST);
3756 vcl_session_clear_attr (session, VCL_SESS_ATTR_BROADCAST);
3758 VDBG (2, "VPPCOM_ATTR_SET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3759 vcl_session_has_attr (session, VCL_SESS_ATTR_BROADCAST),
3766 case VPPCOM_ATTR_GET_V6ONLY:
3767 if (buffer && buflen && (*buflen >= sizeof (int)))
3770 *(int *) buffer = vcl_session_has_attr (session,
3771 VCL_SESS_ATTR_V6ONLY);
3772 *buflen = sizeof (int);
3774 VDBG (2, "VPPCOM_ATTR_GET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3775 *(int *) buffer, *buflen);
3781 case VPPCOM_ATTR_SET_V6ONLY:
3782 if (buffer && buflen && (*buflen == sizeof (int)))
3785 if (*(int *) buffer)
3786 vcl_session_set_attr (session, VCL_SESS_ATTR_V6ONLY);
3788 vcl_session_clear_attr (session, VCL_SESS_ATTR_V6ONLY);
3790 VDBG (2, "VPPCOM_ATTR_SET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3791 vcl_session_has_attr (session, VCL_SESS_ATTR_V6ONLY),
3798 case VPPCOM_ATTR_GET_KEEPALIVE:
3799 if (buffer && buflen && (*buflen >= sizeof (int)))
3802 *(int *) buffer = vcl_session_has_attr (session,
3803 VCL_SESS_ATTR_KEEPALIVE);
3804 *buflen = sizeof (int);
3806 VDBG (2, "VPPCOM_ATTR_GET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3807 *(int *) buffer, *buflen);
3813 case VPPCOM_ATTR_SET_KEEPALIVE:
3814 if (buffer && buflen && (*buflen == sizeof (int)))
3817 if (*(int *) buffer)
3818 vcl_session_set_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3820 vcl_session_clear_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3822 VDBG (2, "VPPCOM_ATTR_SET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3823 vcl_session_has_attr (session, VCL_SESS_ATTR_KEEPALIVE),
3830 case VPPCOM_ATTR_GET_TCP_NODELAY:
3831 if (buffer && buflen && (*buflen >= sizeof (int)))
3834 *(int *) buffer = vcl_session_has_attr (session,
3835 VCL_SESS_ATTR_TCP_NODELAY);
3836 *buflen = sizeof (int);
3838 VDBG (2, "VPPCOM_ATTR_GET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3839 *(int *) buffer, *buflen);
3845 case VPPCOM_ATTR_SET_TCP_NODELAY:
3846 if (buffer && buflen && (*buflen == sizeof (int)))
3849 if (*(int *) buffer)
3850 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3852 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3854 VDBG (2, "VPPCOM_ATTR_SET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3855 vcl_session_has_attr (session, VCL_SESS_ATTR_TCP_NODELAY),
3862 case VPPCOM_ATTR_GET_TCP_KEEPIDLE:
3863 if (buffer && buflen && (*buflen >= sizeof (int)))
3866 *(int *) buffer = vcl_session_has_attr (session,
3867 VCL_SESS_ATTR_TCP_KEEPIDLE);
3868 *buflen = sizeof (int);
3870 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3871 *(int *) buffer, *buflen);
3877 case VPPCOM_ATTR_SET_TCP_KEEPIDLE:
3878 if (buffer && buflen && (*buflen == sizeof (int)))
3881 if (*(int *) buffer)
3882 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3884 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3886 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3887 vcl_session_has_attr (session,
3888 VCL_SESS_ATTR_TCP_KEEPIDLE), *buflen);
3894 case VPPCOM_ATTR_GET_TCP_KEEPINTVL:
3895 if (buffer && buflen && (*buflen >= sizeof (int)))
3898 *(int *) buffer = vcl_session_has_attr (session,
3899 VCL_SESS_ATTR_TCP_KEEPINTVL);
3900 *buflen = sizeof (int);
3902 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3903 *(int *) buffer, *buflen);
3909 case VPPCOM_ATTR_SET_TCP_KEEPINTVL:
3910 if (buffer && buflen && (*buflen == sizeof (int)))
3913 if (*(int *) buffer)
3914 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3916 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3918 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3919 vcl_session_has_attr (session,
3920 VCL_SESS_ATTR_TCP_KEEPINTVL), *buflen);
3926 case VPPCOM_ATTR_GET_TCP_USER_MSS:
3927 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
3933 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3934 tea.mss = *(u32 *) buffer;
3935 if (vcl_session_transport_attr (wrk, session, 1 /* is_get */, &tea))
3936 rv = VPPCOM_ENOPROTOOPT;
3940 *(u32 *) buffer = tea.mss;
3941 *buflen = sizeof (int);
3944 VDBG (2, "VPPCOM_ATTR_GET_TCP_USER_MSS: %d, buflen %d", *(int *) buffer,
3948 case VPPCOM_ATTR_SET_TCP_USER_MSS:
3949 if (!(buffer && buflen && (*buflen == sizeof (u32))))
3955 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3956 tea.mss = *(u32 *) buffer;
3957 if (vcl_session_transport_attr (wrk, session, 0 /* is_get */, &tea))
3958 rv = VPPCOM_ENOPROTOOPT;
3960 VDBG (2, "VPPCOM_ATTR_SET_TCP_USER_MSS: %u, buflen %d", tea.mss,
3964 case VPPCOM_ATTR_SET_CONNECTED:
3965 session->flags |= VCL_SESSION_F_CONNECTED;
3968 case VPPCOM_ATTR_SET_CKPAIR:
3969 if (!(buffer && buflen && (*buflen == sizeof (int))) ||
3970 !vcl_session_has_crypto (session))
3975 if (!session->ext_config)
3977 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_CRYPTO,
3978 sizeof (transport_endpt_ext_cfg_t));
3980 else if (session->ext_config->type != TRANSPORT_ENDPT_EXT_CFG_CRYPTO)
3986 session->ext_config->crypto.ckpair_index = *(uint32_t *) buffer;
3989 case VPPCOM_ATTR_SET_VRF:
3990 if (!(buffer && buflen && (*buflen == sizeof (u32))))
3995 session->vrf = *(u32 *) buffer;
3998 case VPPCOM_ATTR_GET_VRF:
3999 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
4004 *(u32 *) buffer = session->vrf;
4005 *buflen = sizeof (u32);
4008 case VPPCOM_ATTR_GET_DOMAIN:
4009 if (!(buffer && buflen && (*buflen >= sizeof (int))))
4015 if (session->transport.is_ip4)
4016 *(int *) buffer = AF_INET;
4018 *(int *) buffer = AF_INET6;
4019 *buflen = sizeof (int);
4021 VDBG (2, "VPPCOM_ATTR_GET_DOMAIN: %d, buflen %u", *(int *) buffer,
4025 case VPPCOM_ATTR_SET_ENDPT_EXT_CFG:
4026 if (!(buffer && buflen && (*buflen > 0)))
4031 if (session->ext_config)
4036 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_NONE,
4037 *buflen + sizeof (u32));
4038 clib_memcpy (session->ext_config->data, buffer, *buflen);
4039 session->ext_config->len = *buflen;
4051 vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
4052 uint32_t buflen, int flags, vppcom_endpt_t * ep)
4054 vcl_worker_t *wrk = vcl_worker_get_current ();
4055 vcl_session_t *session;
4059 rv = vppcom_session_read (session_handle, buffer, buflen);
4060 else if (flags & MSG_PEEK)
4061 rv = vppcom_session_peek (session_handle, buffer, buflen);
4064 VDBG (0, "Unsupport flags for recvfrom %d", flags);
4065 return VPPCOM_EAFNOSUPPORT;
4070 session = vcl_session_get_w_handle (wrk, session_handle);
4071 if (session->transport.is_ip4)
4072 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
4073 sizeof (ip4_address_t));
4075 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
4076 sizeof (ip6_address_t));
4077 ep->is_ip4 = session->transport.is_ip4;
4078 ep->port = session->transport.rmt_port;
4085 vppcom_session_sendto (uint32_t session_handle, void *buffer,
4086 uint32_t buflen, int flags, vppcom_endpt_t * ep)
4088 vcl_worker_t *wrk = vcl_worker_get_current ();
4091 s = vcl_session_get_w_handle (wrk, session_handle);
4092 if (PREDICT_FALSE (!s))
4093 return VPPCOM_EBADFD;
4097 if (!vcl_session_is_cl (s))
4098 return VPPCOM_EINVAL;
4100 s->transport.is_ip4 = ep->is_ip4;
4101 s->transport.rmt_port = ep->port;
4102 vcl_ip_copy_from_ep (&s->transport.rmt_ip, ep);
4104 /* Session not connected/bound in vpp. Create it by 'connecting' it */
4105 if (PREDICT_FALSE (s->session_state == VCL_STATE_CLOSED))
4107 u32 session_index = s->session_index;
4108 f64 timeout = vcm->cfg.session_timeout;
4111 vcl_send_session_connect (wrk, s);
4112 rv = vppcom_wait_for_session_state_change (session_index,
4117 s = vcl_session_get (wrk, session_index);
4123 // TBD check the flags and do the right thing
4124 VDBG (2, "handling flags 0x%u (%d) not implemented yet.", flags, flags);
4127 return (vppcom_session_write_inline (wrk, s, buffer, buflen, 1,
4128 s->is_dgram ? 1 : 0));
4132 vppcom_poll (vcl_poll_t * vp, uint32_t n_sids, double wait_for_time)
4134 vcl_worker_t *wrk = vcl_worker_get_current ();
4135 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
4136 u32 i, keep_trying = 1;
4137 svm_msg_q_msg_t msg;
4141 VDBG (3, "vp %p, nsids %u, wait_for_time %f", vp, n_sids, wait_for_time);
4144 return VPPCOM_EFAULT;
4148 vcl_session_t *session;
4150 /* Dequeue all events and drop all unhandled io events */
4151 while (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0) == 0)
4153 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
4154 vcl_handle_mq_event (wrk, e);
4155 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
4157 vec_reset_length (wrk->unhandled_evts_vector);
4159 for (i = 0; i < n_sids; i++)
4161 session = vcl_session_get (wrk, vp[i].sh);
4164 vp[i].revents = POLLHUP;
4171 if (POLLIN & vp[i].events)
4173 rv = vcl_session_read_ready (session);
4176 vp[i].revents |= POLLIN;
4183 case VPPCOM_ECONNRESET:
4184 vp[i].revents = POLLHUP;
4188 vp[i].revents = POLLERR;
4195 if (POLLOUT & vp[i].events)
4197 rv = vcl_session_write_ready (session);
4200 vp[i].revents |= POLLOUT;
4207 case VPPCOM_ECONNRESET:
4208 vp[i].revents = POLLHUP;
4212 vp[i].revents = POLLERR;
4219 if (0) // Note "done:" label used by VCL_SESSION_LOCK_AND_GET()
4221 vp[i].revents = POLLNVAL;
4225 if (wait_for_time != -1)
4226 keep_trying = (clib_time_now (&wrk->clib_time) <= timeout) ? 1 : 0;
4228 while ((num_ev == 0) && keep_trying);
4234 vppcom_mq_epoll_fd (void)
4236 vcl_worker_t *wrk = vcl_worker_get_current ();
4237 return wrk->mqs_epfd;
4241 vppcom_session_index (vcl_session_handle_t session_handle)
4243 return session_handle & 0xFFFFFF;
4247 vppcom_session_worker (vcl_session_handle_t session_handle)
4249 return session_handle >> 24;
4253 vppcom_worker_register (void)
4255 if (!vcl_worker_alloc_and_init ())
4256 return VPPCOM_EEXIST;
4258 if (vcl_worker_register_with_vpp ())
4259 return VPPCOM_EEXIST;
4265 vppcom_worker_unregister (void)
4267 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
4268 vcl_set_worker_index (~0);
4272 vppcom_worker_index_set (int index)
4274 vcl_set_worker_index (index);
4278 vppcom_worker_index (void)
4280 return vcl_get_worker_index ();
4284 vppcom_worker_mqs_epfd (void)
4286 vcl_worker_t *wrk = vcl_worker_get_current ();
4287 if (!vcm->cfg.use_mq_eventfd)
4289 return wrk->mqs_epfd;
4293 vppcom_session_is_connectable_listener (uint32_t session_handle)
4295 vcl_session_t *session;
4296 vcl_worker_t *wrk = vcl_worker_get_current ();
4297 session = vcl_session_get_w_handle (wrk, session_handle);
4299 return VPPCOM_EBADFD;
4300 return vcl_session_is_connectable_listener (wrk, session);
4304 vppcom_session_listener (uint32_t session_handle)
4306 vcl_worker_t *wrk = vcl_worker_get_current ();
4307 vcl_session_t *listen_session, *session;
4308 session = vcl_session_get_w_handle (wrk, session_handle);
4310 return VPPCOM_EBADFD;
4311 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
4312 return VPPCOM_EBADFD;
4313 listen_session = vcl_session_get_w_handle (wrk, session->listener_index);
4314 if (!listen_session)
4315 return VPPCOM_EBADFD;
4316 return vcl_session_handle (listen_session);
4320 vppcom_session_n_accepted (uint32_t session_handle)
4322 vcl_worker_t *wrk = vcl_worker_get_current ();
4323 vcl_session_t *session = vcl_session_get_w_handle (wrk, session_handle);
4325 return VPPCOM_EBADFD;
4326 return session->n_accepted_sessions;
4330 vppcom_proto_str (vppcom_proto_t proto)
4332 char const *proto_str;
4336 case VPPCOM_PROTO_TCP:
4339 case VPPCOM_PROTO_UDP:
4342 case VPPCOM_PROTO_TLS:
4345 case VPPCOM_PROTO_QUIC:
4348 case VPPCOM_PROTO_DTLS:
4351 case VPPCOM_PROTO_SRTP:
4355 proto_str = "UNKNOWN";
4362 vppcom_retval_str (int retval)
4373 st = "VPPCOM_EAGAIN";
4377 st = "VPPCOM_EFAULT";
4381 st = "VPPCOM_ENOMEM";
4385 st = "VPPCOM_EINVAL";
4389 st = "VPPCOM_EBADFD";
4392 case VPPCOM_EAFNOSUPPORT:
4393 st = "VPPCOM_EAFNOSUPPORT";
4396 case VPPCOM_ECONNABORTED:
4397 st = "VPPCOM_ECONNABORTED";
4400 case VPPCOM_ECONNRESET:
4401 st = "VPPCOM_ECONNRESET";
4404 case VPPCOM_ENOTCONN:
4405 st = "VPPCOM_ENOTCONN";
4408 case VPPCOM_ECONNREFUSED:
4409 st = "VPPCOM_ECONNREFUSED";
4412 case VPPCOM_ETIMEDOUT:
4413 st = "VPPCOM_ETIMEDOUT";
4417 st = "UNKNOWN_STATE";
4425 vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
4427 if (vcm->cfg.vpp_app_socket_api)
4428 return vcl_sapi_add_cert_key_pair (ckpair);
4430 return vcl_bapi_add_cert_key_pair (ckpair);
4434 vppcom_del_cert_key_pair (uint32_t ckpair_index)
4436 if (vcm->cfg.vpp_app_socket_api)
4437 return vcl_sapi_del_cert_key_pair (ckpair_index);
4439 return vcl_bapi_del_cert_key_pair (ckpair_index);
4443 * fd.io coding-style-patch-verification: ON
4446 * eval: (c-set-style "gnu")