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;
222 mp->wrk_index = wrk->vpp_wrk_index;
223 mp->is_ip4 = s->transport.is_ip4;
224 mp->parent_handle = s->parent_handle;
225 clib_memcpy_fast (&mp->ip, &s->transport.rmt_ip, sizeof (mp->ip));
226 clib_memcpy_fast (&mp->lcl_ip, &s->transport.lcl_ip, sizeof (mp->lcl_ip));
227 mp->port = s->transport.rmt_port;
228 mp->lcl_port = s->transport.lcl_port;
229 mp->proto = s->session_type;
231 if (s->flags & VCL_SESSION_F_CONNECTED)
232 mp->flags |= TRANSPORT_CFG_F_CONNECTED;
234 vcl_msg_add_ext_config (s, &mp->ext_config);
235 app_send_ctrl_evt_to_vpp (mq, app_evt);
239 clib_mem_free (s->ext_config);
245 vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s)
247 app_session_evt_t _app_evt, *app_evt = &_app_evt;
248 session_unlisten_msg_t *mp;
251 mq = vcl_worker_ctrl_mq (wrk);
252 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_UNLISTEN);
253 mp = (session_unlisten_msg_t *) app_evt->evt->data;
254 memset (mp, 0, sizeof (*mp));
255 mp->client_index = wrk->api_client_handle;
256 mp->wrk_index = wrk->vpp_wrk_index;
257 mp->handle = s->vpp_handle;
258 mp->context = wrk->wrk_index;
259 app_send_ctrl_evt_to_vpp (mq, app_evt);
263 vcl_send_session_shutdown (vcl_worker_t *wrk, vcl_session_t *s)
265 app_session_evt_t _app_evt, *app_evt = &_app_evt;
266 session_shutdown_msg_t *mp;
269 /* Send to thread that owns the session */
271 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_SHUTDOWN);
272 mp = (session_shutdown_msg_t *) app_evt->evt->data;
273 memset (mp, 0, sizeof (*mp));
274 mp->client_index = wrk->api_client_handle;
275 mp->handle = s->vpp_handle;
276 app_send_ctrl_evt_to_vpp (mq, app_evt);
280 vcl_send_session_disconnect (vcl_worker_t * wrk, vcl_session_t * s)
282 app_session_evt_t _app_evt, *app_evt = &_app_evt;
283 session_disconnect_msg_t *mp;
286 /* Send to thread that owns the session */
288 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_DISCONNECT);
289 mp = (session_disconnect_msg_t *) app_evt->evt->data;
290 memset (mp, 0, sizeof (*mp));
291 mp->client_index = wrk->api_client_handle;
292 mp->handle = s->vpp_handle;
293 app_send_ctrl_evt_to_vpp (mq, app_evt);
297 vcl_send_app_detach (vcl_worker_t * wrk)
299 app_session_evt_t _app_evt, *app_evt = &_app_evt;
300 session_app_detach_msg_t *mp;
303 mq = vcl_worker_ctrl_mq (wrk);
304 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_DETACH);
305 mp = (session_app_detach_msg_t *) app_evt->evt->data;
306 memset (mp, 0, sizeof (*mp));
307 mp->client_index = wrk->api_client_handle;
308 app_send_ctrl_evt_to_vpp (mq, app_evt);
312 vcl_send_session_accepted_reply (svm_msg_q_t * mq, u32 context,
313 session_handle_t handle, int retval)
315 app_session_evt_t _app_evt, *app_evt = &_app_evt;
316 session_accepted_reply_msg_t *rmp;
317 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_ACCEPTED_REPLY);
318 rmp = (session_accepted_reply_msg_t *) app_evt->evt->data;
319 rmp->handle = handle;
320 rmp->context = context;
321 rmp->retval = retval;
322 app_send_ctrl_evt_to_vpp (mq, app_evt);
326 vcl_send_session_disconnected_reply (vcl_worker_t * wrk, vcl_session_t * s,
329 app_session_evt_t _app_evt, *app_evt = &_app_evt;
330 session_disconnected_reply_msg_t *rmp;
331 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
332 SESSION_CTRL_EVT_DISCONNECTED_REPLY);
333 rmp = (session_disconnected_reply_msg_t *) app_evt->evt->data;
334 rmp->handle = s->vpp_handle;
335 rmp->context = wrk->api_client_handle;
336 rmp->retval = retval;
337 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
341 vcl_send_session_reset_reply (vcl_worker_t * wrk, vcl_session_t * s,
344 app_session_evt_t _app_evt, *app_evt = &_app_evt;
345 session_reset_reply_msg_t *rmp;
346 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
347 SESSION_CTRL_EVT_RESET_REPLY);
348 rmp = (session_reset_reply_msg_t *) app_evt->evt->data;
349 rmp->handle = s->vpp_handle;
350 rmp->context = wrk->api_client_handle;
351 rmp->retval = retval;
352 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
356 vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
359 app_session_evt_t _app_evt, *app_evt = &_app_evt;
360 session_worker_update_msg_t *mp;
362 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
363 SESSION_CTRL_EVT_WORKER_UPDATE);
364 mp = (session_worker_update_msg_t *) app_evt->evt->data;
365 mp->client_index = wrk->api_client_handle;
366 mp->handle = s->vpp_handle;
367 mp->req_wrk_index = wrk->vpp_wrk_index;
368 mp->wrk_index = wrk_index;
369 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
373 vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len)
375 app_session_evt_t _app_evt, *app_evt = &_app_evt;
376 session_app_wrk_rpc_msg_t *mp;
377 vcl_worker_t *dst_wrk, *wrk;
381 if (data_len > sizeof (mp->data))
384 clib_spinlock_lock (&vcm->workers_lock);
386 dst_wrk = vcl_worker_get_if_valid (dst_wrk_index);
390 wrk = vcl_worker_get_current ();
391 mq = vcl_worker_ctrl_mq (wrk);
392 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_WRK_RPC);
393 mp = (session_app_wrk_rpc_msg_t *) app_evt->evt->data;
394 mp->client_index = wrk->api_client_handle;
395 mp->wrk_index = dst_wrk->vpp_wrk_index;
396 clib_memcpy (mp->data, data, data_len);
397 app_send_ctrl_evt_to_vpp (mq, app_evt);
401 clib_spinlock_unlock (&vcm->workers_lock);
406 vcl_session_transport_attr (vcl_worker_t *wrk, vcl_session_t *s, u8 is_get,
407 transport_endpt_attr_t *attr)
409 app_session_evt_t _app_evt, *app_evt = &_app_evt;
410 session_transport_attr_msg_t *mp;
414 ASSERT (!wrk->session_attr_op);
415 wrk->session_attr_op = 1;
416 wrk->session_attr_op_rv = -1;
419 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_TRANSPORT_ATTR);
420 mp = (session_transport_attr_msg_t *) app_evt->evt->data;
421 memset (mp, 0, sizeof (*mp));
422 mp->client_index = wrk->api_client_handle;
423 mp->handle = s->vpp_handle;
426 app_send_ctrl_evt_to_vpp (mq, app_evt);
428 timeout = clib_time_now (&wrk->clib_time) + 1;
430 while (wrk->session_attr_op && clib_time_now (&wrk->clib_time) < timeout)
431 vcl_flush_mq_events ();
433 if (!wrk->session_attr_op_rv && is_get)
434 *attr = wrk->session_attr_rv;
436 wrk->session_attr_op = 0;
438 return wrk->session_attr_op_rv;
442 vcl_session_accepted_handler (vcl_worker_t * wrk, session_accepted_msg_t * mp,
445 vcl_session_t *session, *listen_session;
448 session = vcl_session_alloc (wrk);
450 listen_session = vcl_session_get (wrk, ls_index);
451 if (listen_session->vpp_handle != mp->listener_handle)
453 VDBG (0, "ERROR: listener handle %lu does not match session %u",
454 mp->listener_handle, ls_index);
458 if (vcl_segment_attach_session (
459 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
460 mp->vpp_event_queue_address, mp->mq_index, 0, session))
462 VDBG (0, "failed to attach fifos for %u", session->session_index);
466 session->vpp_handle = mp->handle;
467 session->session_state = VCL_STATE_READY;
468 session->transport.rmt_port = mp->rmt.port;
469 session->transport.is_ip4 = mp->rmt.is_ip4;
470 clib_memcpy_fast (&session->transport.rmt_ip, &mp->rmt.ip,
471 sizeof (ip46_address_t));
473 vcl_session_table_add_vpp_handle (wrk, mp->handle, session->session_index);
474 session->transport.lcl_port = mp->lcl.port;
475 session->transport.lcl_ip = mp->lcl.ip;
476 session->session_type = listen_session->session_type;
477 session->is_dgram = vcl_proto_is_dgram (session->session_type);
478 session->listener_index = listen_session->session_index;
479 listen_session->n_accepted_sessions++;
481 VDBG (1, "session %u [0x%llx]: client accept request from %s address %U"
482 " port %d queue %p!", session->session_index, mp->handle,
483 mp->rmt.is_ip4 ? "IPv4" : "IPv6", format_ip46_address, &mp->rmt.ip,
484 mp->rmt.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
485 clib_net_to_host_u16 (mp->rmt.port), session->vpp_evt_q);
486 vcl_evt (VCL_EVT_ACCEPT, session, listen_session, session_index);
488 vcl_send_session_accepted_reply (session->vpp_evt_q, mp->context,
489 session->vpp_handle, 0);
491 return session->session_index;
494 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0),
495 mp->vpp_event_queue_address, mp->mq_index, &evt_q);
496 vcl_send_session_accepted_reply (evt_q, mp->context, mp->handle,
497 VNET_API_ERROR_INVALID_ARGUMENT);
498 vcl_session_free (wrk, session);
499 return VCL_INVALID_SESSION_INDEX;
503 vcl_session_connected_handler (vcl_worker_t * wrk,
504 session_connected_msg_t * mp)
506 vcl_session_t *session = 0;
509 session_index = mp->context;
510 session = vcl_session_get (wrk, session_index);
513 VDBG (0, "ERROR: vpp handle 0x%llx has no session index (%u)!",
514 mp->handle, session_index);
515 return VCL_INVALID_SESSION_INDEX;
519 VDBG (0, "ERROR: session index %u: connect failed! %U",
520 session_index, format_session_error, mp->retval);
521 session->session_state = VCL_STATE_DETACHED;
522 session->vpp_handle = mp->handle;
523 return session_index;
526 session->vpp_handle = mp->handle;
528 if (vcl_segment_attach_session (
529 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
530 mp->vpp_event_queue_address, mp->mq_index, 0, session))
532 VDBG (0, "failed to attach fifos for %u", session->session_index);
533 session->session_state = VCL_STATE_DETACHED;
534 vcl_send_session_disconnect (wrk, session);
535 return session_index;
540 if (vcl_segment_attach_session (mp->ct_segment_handle, mp->ct_rx_fifo,
541 mp->ct_tx_fifo, (uword) ~0, ~0, 1,
544 VDBG (0, "failed to attach ct fifos for %u", session->session_index);
545 session->session_state = VCL_STATE_DETACHED;
546 vcl_send_session_disconnect (wrk, session);
547 return session_index;
551 session->transport.is_ip4 = mp->lcl.is_ip4;
552 clib_memcpy_fast (&session->transport.lcl_ip, &mp->lcl.ip,
553 sizeof (session->transport.lcl_ip));
554 session->transport.lcl_port = mp->lcl.port;
556 /* Application closed session before connect reply */
557 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK)
558 && session->session_state == VCL_STATE_CLOSED)
559 vcl_send_session_disconnect (wrk, session);
561 session->session_state = VCL_STATE_READY;
563 /* Add it to lookup table */
564 vcl_session_table_add_vpp_handle (wrk, mp->handle, session_index);
566 VDBG (1, "session %u [0x%llx] connected! rx_fifo %p, refcnt %d, tx_fifo %p,"
567 " refcnt %d", session_index, mp->handle, session->rx_fifo,
568 session->rx_fifo->refcnt, session->tx_fifo, session->tx_fifo->refcnt);
570 return session_index;
574 vcl_flag_accepted_session (vcl_session_t * session, u64 handle, u32 flags)
576 vcl_session_msg_t *accepted_msg;
579 for (i = 0; i < vec_len (session->accept_evts_fifo); i++)
581 accepted_msg = &session->accept_evts_fifo[i];
582 if (accepted_msg->accepted_msg.handle == handle)
584 accepted_msg->flags |= flags;
592 vcl_session_reset_handler (vcl_worker_t * wrk,
593 session_reset_msg_t * reset_msg)
595 vcl_session_t *session;
598 sid = vcl_session_index_from_vpp_handle (wrk, reset_msg->handle);
599 session = vcl_session_get (wrk, sid);
602 VDBG (0, "request to reset unknown handle 0x%llx", reset_msg->handle);
603 return VCL_INVALID_SESSION_INDEX;
606 /* Caught a reset before actually accepting the session */
607 if (session->session_state == VCL_STATE_LISTEN)
610 if (!vcl_flag_accepted_session (session, reset_msg->handle,
611 VCL_ACCEPTED_F_RESET))
612 VDBG (0, "session was not accepted!");
613 return VCL_INVALID_SESSION_INDEX;
616 if (session->session_state != VCL_STATE_CLOSED)
617 session->session_state = VCL_STATE_DISCONNECT;
618 VDBG (0, "reset session %u [0x%llx]", sid, reset_msg->handle);
623 vcl_session_bound_handler (vcl_worker_t * wrk, session_bound_msg_t * mp)
625 vcl_session_t *session;
626 u32 sid = mp->context;
628 session = vcl_session_get (wrk, sid);
631 VERR ("session %u [0x%llx]: bind failed: %U", sid, mp->handle,
632 format_session_error, mp->retval);
635 session->session_state = VCL_STATE_DETACHED;
636 session->vpp_handle = mp->handle;
641 VDBG (0, "ERROR: session %u [0x%llx]: Invalid session index!",
643 return VCL_INVALID_SESSION_INDEX;
647 session->vpp_handle = mp->handle;
648 session->transport.is_ip4 = mp->lcl_is_ip4;
649 clib_memcpy_fast (&session->transport.lcl_ip, mp->lcl_ip,
650 sizeof (ip46_address_t));
651 session->transport.lcl_port = mp->lcl_port;
652 vcl_session_table_add_listener (wrk, mp->handle, sid);
653 session->session_state = VCL_STATE_LISTEN;
655 if (vcl_session_is_cl (session))
657 if (vcl_segment_attach_session (mp->segment_handle, mp->rx_fifo,
658 mp->tx_fifo, mp->vpp_evt_q, mp->mq_index,
661 VDBG (0, "failed to attach fifos for %u", session->session_index);
662 session->session_state = VCL_STATE_DETACHED;
663 return VCL_INVALID_SESSION_INDEX;
667 VDBG (0, "session %u [0x%llx]: listen succeeded!", sid, mp->handle);
672 vcl_session_unlisten_reply_handler (vcl_worker_t * wrk, void *data)
674 session_unlisten_reply_msg_t *mp = (session_unlisten_reply_msg_t *) data;
677 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
680 VDBG (0, "Unlisten reply with wrong handle %llx", mp->handle);
683 if (s->session_state != VCL_STATE_DISCONNECT)
685 /* Connected udp listener */
686 if (s->session_type == VPPCOM_PROTO_UDP
687 && s->session_state == VCL_STATE_CLOSED)
690 VDBG (0, "Unlisten session in wrong state %llx", mp->handle);
695 VDBG (0, "ERROR: session %u [0xllx]: unlisten failed: %U",
696 s->session_index, mp->handle, format_session_error, mp->retval);
698 if (mp->context != wrk->wrk_index)
699 VDBG (0, "wrong context");
701 vcl_session_table_del_vpp_handle (wrk, mp->handle);
702 vcl_session_free (wrk, s);
706 vcl_session_migrated_handler (vcl_worker_t * wrk, void *data)
708 session_migrated_msg_t *mp = (session_migrated_msg_t *) data;
712 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
715 VDBG (0, "Migrated notification with wrong handle %llx", mp->handle);
719 /* Only validate if a value is provided */
720 if (mp->segment_handle != SESSION_INVALID_HANDLE)
722 fs_index = vcl_segment_table_lookup (mp->segment_handle);
723 if (fs_index == VCL_INVALID_SEGMENT_INDEX)
725 VDBG (0, "segment %lx for session %u is not mounted!",
726 mp->segment_handle, s->session_index);
727 s->session_state = VCL_STATE_DETACHED;
732 s->vpp_handle = mp->new_handle;
734 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0), mp->vpp_evt_q,
735 mp->vpp_thread_index, &s->vpp_evt_q);
737 vcl_session_table_del_vpp_handle (wrk, mp->handle);
738 vcl_session_table_add_vpp_handle (wrk, mp->new_handle, s->session_index);
740 /* Generate new tx event if we have outstanding data */
741 if (svm_fifo_has_event (s->tx_fifo))
742 app_send_io_evt_to_vpp (s->vpp_evt_q,
743 s->tx_fifo->shr->master_session_index,
744 SESSION_IO_EVT_TX, SVM_Q_WAIT);
746 VDBG (0, "Migrated 0x%lx to thread %u 0x%lx", mp->handle,
747 mp->vpp_thread_index, mp->new_handle);
750 static vcl_session_t *
751 vcl_session_accepted (vcl_worker_t * wrk, session_accepted_msg_t * msg)
753 vcl_session_msg_t *vcl_msg;
754 vcl_session_t *session;
756 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
757 if (PREDICT_FALSE (session != 0))
758 VWRN ("session overlap handle %lu state %u!", msg->handle,
759 session->session_state);
761 session = vcl_session_table_lookup_listener (wrk, msg->listener_handle);
764 VERR ("couldn't find listen session: listener handle %llx",
765 msg->listener_handle);
769 clib_fifo_add2 (session->accept_evts_fifo, vcl_msg);
771 vcl_msg->accepted_msg = *msg;
772 /* Session handle points to listener until fully accepted by app */
773 vcl_session_table_add_vpp_handle (wrk, msg->handle, session->session_index);
778 static vcl_session_t *
779 vcl_session_disconnected_handler (vcl_worker_t * wrk,
780 session_disconnected_msg_t * msg)
782 vcl_session_t *session;
784 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
787 VDBG (0, "request to disconnect unknown handle 0x%llx", msg->handle);
791 /* Late disconnect notification on a session that has been closed */
792 if (session->session_state == VCL_STATE_CLOSED)
795 /* Caught a disconnect before actually accepting the session */
796 if (session->session_state == VCL_STATE_LISTEN)
798 if (!vcl_flag_accepted_session (session, msg->handle,
799 VCL_ACCEPTED_F_CLOSED))
800 VDBG (0, "session was not accepted!");
804 /* If not already reset change state */
805 if (session->session_state != VCL_STATE_DISCONNECT)
806 session->session_state = VCL_STATE_VPP_CLOSING;
812 vppcom_session_shutdown (uint32_t session_handle, int how)
814 vcl_worker_t *wrk = vcl_worker_get_current ();
815 vcl_session_t *session;
816 vcl_session_state_t state;
819 session = vcl_session_get_w_handle (wrk, session_handle);
820 if (PREDICT_FALSE (!session))
821 return VPPCOM_EBADFD;
823 vpp_handle = session->vpp_handle;
824 state = session->session_state;
826 VDBG (1, "session %u [0x%llx] state 0x%x (%s)", session->session_index,
827 vpp_handle, state, vppcom_session_state_str (state));
829 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
831 VDBG (0, "ERROR: Cannot shutdown a listen socket!");
832 return VPPCOM_EBADFD;
835 if (how == SHUT_RD || how == SHUT_RDWR)
837 session->flags |= VCL_SESSION_F_RD_SHUTDOWN;
841 session->flags |= VCL_SESSION_F_WR_SHUTDOWN;
843 if (PREDICT_TRUE (state == VCL_STATE_READY))
845 VDBG (1, "session %u [0x%llx]: sending shutdown...",
846 session->session_index, vpp_handle);
848 vcl_send_session_shutdown (wrk, session);
855 vppcom_session_disconnect (u32 session_handle)
857 vcl_worker_t *wrk = vcl_worker_get_current ();
858 vcl_session_t *session, *listen_session;
859 vcl_session_state_t state;
862 session = vcl_session_get_w_handle (wrk, session_handle);
864 return VPPCOM_EBADFD;
866 vpp_handle = session->vpp_handle;
867 state = session->session_state;
869 VDBG (1, "session %u [0x%llx] state 0x%x (%s)", session->session_index,
870 vpp_handle, state, vppcom_session_state_str (state));
872 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
874 VDBG (0, "ERROR: Cannot disconnect a listen socket!");
875 return VPPCOM_EBADFD;
878 if (state == VCL_STATE_VPP_CLOSING)
880 vcl_send_session_disconnected_reply (wrk, session, 0);
881 VDBG (1, "session %u [0x%llx]: sending disconnect REPLY...",
882 session->session_index, vpp_handle);
886 /* Session doesn't have an event queue yet. Probably a non-blocking
887 * connect. Wait for the reply */
888 if (PREDICT_FALSE (!session->vpp_evt_q))
891 VDBG (1, "session %u [0x%llx]: sending disconnect...",
892 session->session_index, vpp_handle);
893 vcl_send_session_disconnect (wrk, session);
896 if (session->listener_index != VCL_INVALID_SESSION_INDEX)
898 listen_session = vcl_session_get (wrk, session->listener_index);
899 listen_session->n_accepted_sessions--;
906 vcl_session_cleanup_handler (vcl_worker_t * wrk, void *data)
908 session_cleanup_msg_t *msg;
909 vcl_session_t *session;
911 msg = (session_cleanup_msg_t *) data;
912 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
915 VDBG (0, "disconnect confirmed for unknown handle 0x%llx", msg->handle);
919 if (msg->type == SESSION_CLEANUP_TRANSPORT)
921 /* Transport was cleaned up before we confirmed close. Probably the
922 * app is still waiting for some data that cannot be delivered.
923 * Confirm close to make sure everything is cleaned up.
924 * Move to undetermined state to ensure that the session is not
925 * removed before both vpp and the app cleanup.
926 * - If the app closes first, the session is moved to CLOSED state
927 * and the session cleanup notification from vpp removes the
929 * - If vpp cleans up the session first, the session is moved to
930 * DETACHED state lower and subsequently the close from the app
933 if (session->session_state == VCL_STATE_VPP_CLOSING)
935 vppcom_session_disconnect (vcl_session_handle (session));
936 session->session_state = VCL_STATE_UPDATED;
938 else if (session->session_state == VCL_STATE_DISCONNECT)
940 vcl_send_session_reset_reply (wrk, session, 0);
941 session->session_state = VCL_STATE_UPDATED;
946 vcl_session_table_del_vpp_handle (wrk, msg->handle);
947 /* Should not happen. App did not close the connection so don't free it. */
948 if (session->session_state != VCL_STATE_CLOSED)
950 VDBG (0, "app did not close session %d", session->session_index);
951 session->session_state = VCL_STATE_DETACHED;
952 session->vpp_handle = VCL_INVALID_SESSION_HANDLE;
955 vcl_session_free (wrk, session);
959 vcl_session_req_worker_update_handler (vcl_worker_t * wrk, void *data)
961 session_req_worker_update_msg_t *msg;
964 msg = (session_req_worker_update_msg_t *) data;
965 s = vcl_session_get_w_vpp_handle (wrk, msg->session_handle);
969 vec_add1 (wrk->pending_session_wrk_updates, s->session_index);
973 vcl_session_worker_update_reply_handler (vcl_worker_t * wrk, void *data)
975 session_worker_update_reply_msg_t *msg;
978 msg = (session_worker_update_reply_msg_t *) data;
979 s = vcl_session_get_w_vpp_handle (wrk, msg->handle);
982 VDBG (0, "unknown handle 0x%llx", msg->handle);
988 if (vcl_segment_attach_session (msg->segment_handle, msg->rx_fifo,
989 msg->tx_fifo, (uword) ~0, ~0, 0, s))
991 VDBG (0, "failed to attach fifos for %u", s->session_index);
995 s->session_state = VCL_STATE_UPDATED;
997 VDBG (0, "session %u[0x%llx] moved to worker %u", s->session_index,
998 s->vpp_handle, wrk->wrk_index);
1002 vcl_api_recv_fd (vcl_worker_t * wrk, int *fds, int n_fds)
1005 if (vcm->cfg.vpp_app_socket_api)
1006 return vcl_sapi_recv_fds (wrk, fds, n_fds);
1008 return vcl_bapi_recv_fds (wrk, fds, n_fds);
1012 vcl_session_app_add_segment_handler (vcl_worker_t * wrk, void *data)
1014 ssvm_segment_type_t seg_type = SSVM_SEGMENT_SHM;
1015 session_app_add_segment_msg_t *msg;
1019 msg = (session_app_add_segment_msg_t *) data;
1023 vcl_api_recv_fd (wrk, &fd, 1);
1024 seg_type = SSVM_SEGMENT_MEMFD;
1027 segment_handle = msg->segment_handle;
1028 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
1030 clib_warning ("invalid segment handle");
1034 if (vcl_segment_attach (segment_handle, (char *) msg->segment_name,
1037 VDBG (0, "vcl_segment_attach ('%s') failed", msg->segment_name);
1041 VDBG (1, "mapped new segment '%s' size %d", msg->segment_name,
1046 vcl_session_app_del_segment_handler (vcl_worker_t * wrk, void *data)
1048 session_app_del_segment_msg_t *msg = (session_app_del_segment_msg_t *) data;
1049 vcl_segment_detach (msg->segment_handle);
1050 VDBG (1, "Unmapped segment: %d", msg->segment_handle);
1054 vcl_worker_rpc_handler (vcl_worker_t * wrk, void *data)
1056 if (!vcm->wrk_rpc_fn)
1059 (vcm->wrk_rpc_fn) (((session_app_wrk_rpc_msg_t *) data)->data);
1063 vcl_session_transport_attr_reply_handler (vcl_worker_t *wrk, void *data)
1065 session_transport_attr_reply_msg_t *mp;
1067 if (!wrk->session_attr_op)
1070 mp = (session_transport_attr_reply_msg_t *) data;
1072 wrk->session_attr_op_rv = mp->retval;
1073 wrk->session_attr_op = 0;
1074 wrk->session_attr_rv = mp->attr;
1078 vcl_handle_mq_event (vcl_worker_t * wrk, session_event_t * e)
1080 session_disconnected_msg_t *disconnected_msg;
1081 session_connected_msg_t *connected_msg;
1082 session_reset_msg_t *reset_msg;
1083 session_event_t *ecpy;
1087 switch (e->event_type)
1089 case SESSION_IO_EVT_RX:
1090 case SESSION_IO_EVT_TX:
1091 s = vcl_session_get (wrk, e->session_index);
1092 if (!s || !vcl_session_is_open (s))
1094 vec_add1 (wrk->unhandled_evts_vector, *e);
1096 case SESSION_CTRL_EVT_BOUND:
1097 /* We can only wait for only one listen so not postponed */
1098 vcl_session_bound_handler (wrk, (session_bound_msg_t *) e->data);
1100 case SESSION_CTRL_EVT_ACCEPTED:
1101 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
1102 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1104 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1106 ecpy->postponed = 1;
1107 ecpy->session_index = s->session_index;
1110 case SESSION_CTRL_EVT_CONNECTED:
1111 connected_msg = (session_connected_msg_t *) e->data;
1112 sid = vcl_session_connected_handler (wrk, connected_msg);
1113 if (!(s = vcl_session_get (wrk, sid)))
1115 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1117 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1119 ecpy->postponed = 1;
1120 ecpy->session_index = s->session_index;
1123 case SESSION_CTRL_EVT_DISCONNECTED:
1124 disconnected_msg = (session_disconnected_msg_t *) e->data;
1125 if (!(s = vcl_session_get_w_vpp_handle (wrk, disconnected_msg->handle)))
1127 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1129 vec_add1 (wrk->unhandled_evts_vector, *e);
1132 if (!(s = vcl_session_disconnected_handler (wrk, disconnected_msg)))
1134 VDBG (0, "disconnected session %u [0x%llx]", s->session_index,
1137 case SESSION_CTRL_EVT_RESET:
1138 reset_msg = (session_reset_msg_t *) e->data;
1139 if (!(s = vcl_session_get_w_vpp_handle (wrk, reset_msg->handle)))
1141 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1143 vec_add1 (wrk->unhandled_evts_vector, *e);
1146 vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
1148 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
1149 vcl_session_unlisten_reply_handler (wrk, e->data);
1151 case SESSION_CTRL_EVT_MIGRATED:
1152 vcl_session_migrated_handler (wrk, e->data);
1154 case SESSION_CTRL_EVT_CLEANUP:
1155 vcl_session_cleanup_handler (wrk, e->data);
1157 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
1158 vcl_session_req_worker_update_handler (wrk, e->data);
1160 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
1161 vcl_session_worker_update_reply_handler (wrk, e->data);
1163 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
1164 vcl_session_app_add_segment_handler (wrk, e->data);
1166 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
1167 vcl_session_app_del_segment_handler (wrk, e->data);
1169 case SESSION_CTRL_EVT_APP_WRK_RPC:
1170 vcl_worker_rpc_handler (wrk, e->data);
1172 case SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY:
1173 vcl_session_transport_attr_reply_handler (wrk, e->data);
1176 clib_warning ("unhandled %u", e->event_type);
1182 vppcom_wait_for_session_state_change (u32 session_index,
1183 vcl_session_state_t state,
1186 vcl_worker_t *wrk = vcl_worker_get_current ();
1187 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
1188 vcl_session_t *volatile session;
1189 svm_msg_q_msg_t msg;
1194 session = vcl_session_get (wrk, session_index);
1195 if (PREDICT_FALSE (!session))
1197 return VPPCOM_EBADFD;
1199 if (session->session_state == state)
1203 if (session->session_state == VCL_STATE_DETACHED)
1205 return VPPCOM_ECONNREFUSED;
1208 if (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0))
1213 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
1214 vcl_handle_mq_event (wrk, e);
1215 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
1217 while (clib_time_now (&wrk->clib_time) < timeout);
1219 VDBG (0, "timeout waiting for state 0x%x (%s)", state,
1220 vppcom_session_state_str (state));
1221 vcl_evt (VCL_EVT_SESSION_TIMEOUT, session, session_state);
1223 return VPPCOM_ETIMEDOUT;
1227 vcl_handle_pending_wrk_updates (vcl_worker_t * wrk)
1229 vcl_session_state_t state;
1233 if (PREDICT_TRUE (vec_len (wrk->pending_session_wrk_updates) == 0))
1236 vec_foreach (sip, wrk->pending_session_wrk_updates)
1238 s = vcl_session_get (wrk, *sip);
1239 vcl_send_session_worker_update (wrk, s, wrk->wrk_index);
1240 state = s->session_state;
1241 vppcom_wait_for_session_state_change (s->session_index, VCL_STATE_UPDATED,
1243 s->session_state = state;
1245 vec_reset_length (wrk->pending_session_wrk_updates);
1249 vcl_worker_flush_mq_events (vcl_worker_t *wrk)
1251 svm_msg_q_msg_t *msg;
1256 mq = wrk->app_event_queue;
1257 vcl_mq_dequeue_batch (wrk, mq, ~0);
1259 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
1261 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
1262 e = svm_msg_q_msg_data (mq, msg);
1263 vcl_handle_mq_event (wrk, e);
1264 svm_msg_q_free_msg (mq, msg);
1266 vec_reset_length (wrk->mq_msg_vector);
1267 vcl_handle_pending_wrk_updates (wrk);
1271 vcl_flush_mq_events (void)
1273 vcl_worker_flush_mq_events (vcl_worker_get_current ());
1277 vppcom_session_unbind (u32 session_handle)
1279 vcl_worker_t *wrk = vcl_worker_get_current ();
1280 session_accepted_msg_t *accepted_msg;
1281 vcl_session_t *session = 0;
1282 vcl_session_msg_t *evt;
1284 session = vcl_session_get_w_handle (wrk, session_handle);
1286 return VPPCOM_EBADFD;
1288 /* Flush pending accept events, if any */
1289 while (clib_fifo_elts (session->accept_evts_fifo))
1291 clib_fifo_sub2 (session->accept_evts_fifo, evt);
1292 accepted_msg = &evt->accepted_msg;
1293 vcl_session_table_del_vpp_handle (wrk, accepted_msg->handle);
1294 vcl_send_session_accepted_reply (session->vpp_evt_q,
1295 accepted_msg->context,
1296 accepted_msg->handle, -1);
1298 clib_fifo_free (session->accept_evts_fifo);
1300 vcl_send_session_unlisten (wrk, session);
1302 VDBG (1, "session %u [0x%llx]: sending unbind!", session->session_index,
1303 session->vpp_handle);
1304 vcl_evt (VCL_EVT_UNBIND, session);
1306 session->vpp_handle = ~0;
1307 session->session_state = VCL_STATE_DISCONNECT;
1315 * Notify vpp of the disconnect and mark the worker as free. If we're the
1316 * last worker, do a full cleanup otherwise, since we're probably a forked
1317 * child, avoid syscalls as much as possible. We might've lost privileges.
1320 vppcom_app_exit (void)
1322 if (!pool_elts (vcm->workers))
1324 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
1325 vcl_set_worker_index (~0);
1326 vcl_elog_stop (vcm);
1330 vcl_api_attach (void)
1332 if (vcm->cfg.vpp_app_socket_api)
1333 return vcl_sapi_attach ();
1335 return vcl_bapi_attach ();
1339 vcl_api_detach (vcl_worker_t * wrk)
1341 vcl_send_app_detach (wrk);
1343 if (vcm->cfg.vpp_app_socket_api)
1344 return vcl_sapi_detach (wrk);
1346 return vcl_bapi_disconnect_from_vpp ();
1350 * VPPCOM Public API functions
1353 vppcom_app_create (const char *app_name)
1355 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1360 VDBG (1, "already initialized");
1361 return VPPCOM_EEXIST;
1365 vppcom_cfg (&vcm->cfg);
1366 vcl_cfg = &vcm->cfg;
1368 vcm->main_cpu = pthread_self ();
1369 vcm->main_pid = getpid ();
1370 vcm->app_name = format (0, "%s", app_name);
1371 fifo_segment_main_init (&vcm->segment_main, (uword) ~0,
1372 20 /* timeout in secs */);
1373 pool_alloc (vcm->workers, vcl_cfg->max_workers);
1374 clib_spinlock_init (&vcm->workers_lock);
1375 clib_rwlock_init (&vcm->segment_table_lock);
1376 atexit (vppcom_app_exit);
1377 vcl_elog_init (vcm);
1379 /* Allocate default worker */
1380 vcl_worker_alloc_and_init ();
1382 if ((rv = vcl_api_attach ()))
1385 VDBG (0, "app_name '%s', my_client_index %d (0x%x)", app_name,
1386 vcm->workers[0].api_client_handle, vcm->workers[0].api_client_handle);
1392 vppcom_app_destroy (void)
1394 vcl_worker_t *wrk, *current_wrk;
1397 if (!pool_elts (vcm->workers))
1400 vcl_evt (VCL_EVT_DETACH, vcm);
1402 current_wrk = vcl_worker_get_current ();
1405 pool_foreach (wrk, vcm->workers) {
1406 if (current_wrk != wrk)
1407 vcl_worker_cleanup (wrk, 0 /* notify vpp */ );
1411 vcl_api_detach (current_wrk);
1412 vcl_worker_cleanup (current_wrk, 0 /* notify vpp */ );
1414 vcl_elog_stop (vcm);
1417 * Free the heap and fix vcm
1419 heap = clib_mem_get_heap ();
1420 munmap (clib_mem_get_heap_base (heap), clib_mem_get_heap_size (heap));
1422 vcm = &_vppcom_main;
1427 vppcom_session_create (u8 proto, u8 is_nonblocking)
1429 vcl_worker_t *wrk = vcl_worker_get_current ();
1430 vcl_session_t *session;
1432 session = vcl_session_alloc (wrk);
1434 session->session_type = proto;
1435 session->session_state = VCL_STATE_CLOSED;
1436 session->vpp_handle = ~0;
1437 session->is_dgram = vcl_proto_is_dgram (proto);
1440 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
1442 vcl_evt (VCL_EVT_CREATE, session, session_type, session->session_state,
1443 is_nonblocking, session_index);
1445 VDBG (0, "created session %u", session->session_index);
1447 return vcl_session_handle (session);
1451 vcl_epoll_lt_add (vcl_worker_t *wrk, vcl_session_t *s)
1453 vcl_session_t *cur, *prev;
1455 if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX)
1457 wrk->ep_lt_current = s->session_index;
1458 s->vep.lt_next = s->session_index;
1459 s->vep.lt_prev = s->session_index;
1463 cur = vcl_session_get (wrk, wrk->ep_lt_current);
1464 prev = vcl_session_get (wrk, cur->vep.lt_prev);
1466 prev->vep.lt_next = s->session_index;
1467 s->vep.lt_prev = prev->session_index;
1469 s->vep.lt_next = cur->session_index;
1470 cur->vep.lt_prev = s->session_index;
1474 vcl_epoll_lt_del (vcl_worker_t *wrk, vcl_session_t *s)
1476 vcl_session_t *prev, *next;
1478 if (s->vep.lt_next == s->session_index)
1480 wrk->ep_lt_current = VCL_INVALID_SESSION_INDEX;
1481 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
1485 prev = vcl_session_get (wrk, s->vep.lt_prev);
1486 next = vcl_session_get (wrk, s->vep.lt_next);
1488 prev->vep.lt_next = next->session_index;
1489 next->vep.lt_prev = prev->session_index;
1491 if (s->session_index == wrk->ep_lt_current)
1492 wrk->ep_lt_current = s->vep.lt_next;
1494 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
1498 vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * s,
1499 vcl_session_handle_t sh, u8 do_disconnect)
1503 VDBG (1, "session %u [0x%llx] closing", s->session_index, s->vpp_handle);
1505 if (s->flags & VCL_SESSION_F_IS_VEP)
1507 u32 next_sh = s->vep.next_sh;
1508 while (next_sh != ~0)
1510 rv = vppcom_epoll_ctl (sh, EPOLL_CTL_DEL, next_sh, 0);
1511 if (PREDICT_FALSE (rv < 0))
1512 VDBG (0, "vpp handle 0x%llx, sh %u: EPOLL_CTL_DEL vep_idx %u"
1513 " failed! rv %d (%s)", s->vpp_handle, next_sh,
1514 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1515 next_sh = s->vep.next_sh;
1520 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
1522 rv = vppcom_epoll_ctl (s->vep.vep_sh, EPOLL_CTL_DEL, sh, 0);
1524 VDBG (0, "session %u [0x%llx]: EPOLL_CTL_DEL vep_idx %u "
1525 "failed! rv %d (%s)", s->session_index, s->vpp_handle,
1526 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1531 VDBG (1, "session %u [0x%llx] disconnect skipped",
1532 s->session_index, s->vpp_handle);
1536 if (s->session_state == VCL_STATE_LISTEN)
1538 rv = vppcom_session_unbind (sh);
1539 if (PREDICT_FALSE (rv < 0))
1540 VDBG (0, "session %u [0x%llx]: listener unbind failed! "
1541 "rv %d (%s)", s->session_index, s->vpp_handle, rv,
1542 vppcom_retval_str (rv));
1545 else if (vcl_session_is_ready (s)
1546 || (vcl_session_is_connectable_listener (wrk, s)))
1548 rv = vppcom_session_disconnect (sh);
1549 if (PREDICT_FALSE (rv < 0))
1550 VDBG (0, "ERROR: session %u [0x%llx]: disconnect failed!"
1551 " rv %d (%s)", s->session_index, s->vpp_handle,
1552 rv, vppcom_retval_str (rv));
1554 else if (s->session_state == VCL_STATE_DISCONNECT)
1556 vcl_send_session_reset_reply (wrk, s, 0);
1558 else if (s->session_state == VCL_STATE_DETACHED)
1560 /* Should not happen. VPP cleaned up before app confirmed close */
1561 VDBG (0, "vpp freed session %d before close", s->session_index);
1565 s->session_state = VCL_STATE_CLOSED;
1567 /* Session is removed only after vpp confirms the disconnect */
1571 vcl_session_table_del_vpp_handle (wrk, s->vpp_handle);
1573 vcl_session_free (wrk, s);
1574 vcl_evt (VCL_EVT_CLOSE, s, rv);
1580 vppcom_session_close (uint32_t session_handle)
1582 vcl_worker_t *wrk = vcl_worker_get_current ();
1583 vcl_session_t *session;
1585 session = vcl_session_get_w_handle (wrk, session_handle);
1587 return VPPCOM_EBADFD;
1588 return vcl_session_cleanup (wrk, session, session_handle,
1589 1 /* do_disconnect */ );
1593 vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep)
1595 vcl_worker_t *wrk = vcl_worker_get_current ();
1596 vcl_session_t *session = 0;
1599 return VPPCOM_EINVAL;
1601 session = vcl_session_get_w_handle (wrk, session_handle);
1603 return VPPCOM_EBADFD;
1605 if (session->flags & VCL_SESSION_F_IS_VEP)
1607 VDBG (0, "ERROR: cannot bind to epoll session %u!",
1608 session->session_index);
1609 return VPPCOM_EBADFD;
1612 session->transport.is_ip4 = ep->is_ip4;
1614 clib_memcpy_fast (&session->transport.lcl_ip.ip4, ep->ip,
1615 sizeof (ip4_address_t));
1617 clib_memcpy_fast (&session->transport.lcl_ip.ip6, ep->ip,
1618 sizeof (ip6_address_t));
1619 session->transport.lcl_port = ep->port;
1621 VDBG (0, "session %u handle %u: binding to local %s address %U port %u, "
1622 "proto %s", session->session_index, session_handle,
1623 session->transport.is_ip4 ? "IPv4" : "IPv6",
1624 format_ip46_address, &session->transport.lcl_ip,
1625 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1626 clib_net_to_host_u16 (session->transport.lcl_port),
1627 vppcom_proto_str (session->session_type));
1628 vcl_evt (VCL_EVT_BIND, session);
1630 if (session->session_type == VPPCOM_PROTO_UDP)
1631 vppcom_session_listen (session_handle, 10);
1637 vppcom_session_listen (uint32_t listen_sh, uint32_t q_len)
1639 vcl_worker_t *wrk = vcl_worker_get_current ();
1640 vcl_session_t *listen_session = 0;
1641 u64 listen_vpp_handle;
1644 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1645 if (!listen_session || (listen_session->flags & VCL_SESSION_F_IS_VEP))
1646 return VPPCOM_EBADFD;
1648 listen_vpp_handle = listen_session->vpp_handle;
1649 if (listen_session->session_state == VCL_STATE_LISTEN)
1651 VDBG (0, "session %u [0x%llx]: already in listen state!",
1652 listen_sh, listen_vpp_handle);
1656 VDBG (0, "session %u: sending vpp listen request...", listen_sh);
1659 * Send listen request to vpp and wait for reply
1661 vcl_send_session_listen (wrk, listen_session);
1662 rv = vppcom_wait_for_session_state_change (listen_session->session_index,
1664 vcm->cfg.session_timeout);
1666 if (PREDICT_FALSE (rv))
1668 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1669 VDBG (0, "session %u [0x%llx]: listen failed! returning %d (%s)",
1670 listen_sh, listen_session->vpp_handle, rv,
1671 vppcom_retval_str (rv));
1679 validate_args_session_accept_ (vcl_worker_t * wrk, vcl_session_t * ls)
1681 if (ls->flags & VCL_SESSION_F_IS_VEP)
1683 VDBG (0, "ERROR: cannot accept on epoll session %u!",
1685 return VPPCOM_EBADFD;
1688 if ((ls->session_state != VCL_STATE_LISTEN)
1689 && (!vcl_session_is_connectable_listener (wrk, ls)))
1691 VDBG (0, "ERROR: session [0x%llx]: not in listen state! state 0x%x"
1692 " (%s)", ls->vpp_handle, ls->session_state,
1693 vppcom_session_state_str (ls->session_state));
1694 return VPPCOM_EBADFD;
1700 vppcom_unformat_proto (uint8_t * proto, char *proto_str)
1702 if (!strcmp (proto_str, "TCP"))
1703 *proto = VPPCOM_PROTO_TCP;
1704 else if (!strcmp (proto_str, "tcp"))
1705 *proto = VPPCOM_PROTO_TCP;
1706 else if (!strcmp (proto_str, "UDP"))
1707 *proto = VPPCOM_PROTO_UDP;
1708 else if (!strcmp (proto_str, "udp"))
1709 *proto = VPPCOM_PROTO_UDP;
1710 else if (!strcmp (proto_str, "TLS"))
1711 *proto = VPPCOM_PROTO_TLS;
1712 else if (!strcmp (proto_str, "tls"))
1713 *proto = VPPCOM_PROTO_TLS;
1714 else if (!strcmp (proto_str, "QUIC"))
1715 *proto = VPPCOM_PROTO_QUIC;
1716 else if (!strcmp (proto_str, "quic"))
1717 *proto = VPPCOM_PROTO_QUIC;
1718 else if (!strcmp (proto_str, "DTLS"))
1719 *proto = VPPCOM_PROTO_DTLS;
1720 else if (!strcmp (proto_str, "dtls"))
1721 *proto = VPPCOM_PROTO_DTLS;
1722 else if (!strcmp (proto_str, "SRTP"))
1723 *proto = VPPCOM_PROTO_SRTP;
1724 else if (!strcmp (proto_str, "srtp"))
1725 *proto = VPPCOM_PROTO_SRTP;
1732 vppcom_session_accept (uint32_t listen_session_handle, vppcom_endpt_t * ep,
1735 u32 client_session_index = ~0, listen_session_index, accept_flags = 0;
1736 vcl_worker_t *wrk = vcl_worker_get_current ();
1737 session_accepted_msg_t accepted_msg;
1738 vcl_session_t *listen_session = 0;
1739 vcl_session_t *client_session = 0;
1740 vcl_session_msg_t *evt;
1746 listen_session = vcl_session_get_w_handle (wrk, listen_session_handle);
1747 if (!listen_session)
1748 return VPPCOM_EBADFD;
1750 listen_session_index = listen_session->session_index;
1751 if ((rv = validate_args_session_accept_ (wrk, listen_session)))
1754 if (clib_fifo_elts (listen_session->accept_evts_fifo))
1756 clib_fifo_sub2 (listen_session->accept_evts_fifo, evt);
1757 accept_flags = evt->flags;
1758 accepted_msg = evt->accepted_msg;
1762 is_nonblocking = vcl_session_has_attr (listen_session,
1763 VCL_SESS_ATTR_NONBLOCK);
1766 if (svm_msg_q_is_empty (wrk->app_event_queue) && is_nonblocking)
1767 return VPPCOM_EAGAIN;
1769 svm_msg_q_wait (wrk->app_event_queue, SVM_MQ_WAIT_EMPTY);
1770 vcl_worker_flush_mq_events (wrk);
1776 client_session_index = vcl_session_accepted_handler (wrk, &accepted_msg,
1777 listen_session_index);
1778 if (client_session_index == VCL_INVALID_SESSION_INDEX)
1779 return VPPCOM_ECONNABORTED;
1781 listen_session = vcl_session_get (wrk, listen_session_index);
1782 client_session = vcl_session_get (wrk, client_session_index);
1784 if (flags & O_NONBLOCK)
1785 vcl_session_set_attr (client_session, VCL_SESS_ATTR_NONBLOCK);
1787 VDBG (1, "listener %u [0x%llx]: Got a connect request! session %u [0x%llx],"
1788 " flags %d, is_nonblocking %u", listen_session->session_index,
1789 listen_session->vpp_handle, client_session_index,
1790 client_session->vpp_handle, flags,
1791 vcl_session_has_attr (client_session, VCL_SESS_ATTR_NONBLOCK));
1795 ep->is_ip4 = client_session->transport.is_ip4;
1796 ep->port = client_session->transport.rmt_port;
1797 if (client_session->transport.is_ip4)
1798 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip4,
1799 sizeof (ip4_address_t));
1801 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip6,
1802 sizeof (ip6_address_t));
1805 VDBG (0, "listener %u [0x%llx] accepted %u [0x%llx] peer: %U:%u "
1806 "local: %U:%u", listen_session_handle, listen_session->vpp_handle,
1807 client_session_index, client_session->vpp_handle,
1808 format_ip46_address, &client_session->transport.rmt_ip,
1809 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1810 clib_net_to_host_u16 (client_session->transport.rmt_port),
1811 format_ip46_address, &client_session->transport.lcl_ip,
1812 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1813 clib_net_to_host_u16 (client_session->transport.lcl_port));
1814 vcl_evt (VCL_EVT_ACCEPT, client_session, listen_session,
1815 client_session_index);
1818 * Session might have been closed already
1822 if (accept_flags & VCL_ACCEPTED_F_CLOSED)
1823 client_session->session_state = VCL_STATE_VPP_CLOSING;
1824 else if (accept_flags & VCL_ACCEPTED_F_RESET)
1825 client_session->session_state = VCL_STATE_DISCONNECT;
1827 return vcl_session_handle (client_session);
1831 vppcom_session_connect (uint32_t session_handle, vppcom_endpt_t * server_ep)
1833 vcl_worker_t *wrk = vcl_worker_get_current ();
1834 vcl_session_t *session = 0;
1838 session = vcl_session_get_w_handle (wrk, session_handle);
1840 return VPPCOM_EBADFD;
1841 session_index = session->session_index;
1843 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1845 VDBG (0, "ERROR: cannot connect epoll session %u!",
1846 session->session_index);
1847 return VPPCOM_EBADFD;
1850 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1852 VDBG (0, "session handle %u [0x%llx]: session already "
1853 "connected to %s %U port %d proto %s, state 0x%x (%s)",
1854 session_handle, session->vpp_handle,
1855 session->transport.is_ip4 ? "IPv4" : "IPv6", format_ip46_address,
1856 &session->transport.rmt_ip, session->transport.is_ip4 ?
1857 IP46_TYPE_IP4 : IP46_TYPE_IP6,
1858 clib_net_to_host_u16 (session->transport.rmt_port),
1859 vppcom_proto_str (session->session_type), session->session_state,
1860 vppcom_session_state_str (session->session_state));
1864 /* Attempt to connect a connectionless listener */
1865 if (PREDICT_FALSE (session->session_state == VCL_STATE_LISTEN))
1867 if (session->session_type != VPPCOM_PROTO_UDP)
1868 return VPPCOM_EINVAL;
1869 vcl_send_session_unlisten (wrk, session);
1870 session->session_state = VCL_STATE_CLOSED;
1873 session->transport.is_ip4 = server_ep->is_ip4;
1874 vcl_ip_copy_from_ep (&session->transport.rmt_ip, server_ep);
1875 session->transport.rmt_port = server_ep->port;
1876 session->parent_handle = VCL_INVALID_SESSION_HANDLE;
1877 session->flags |= VCL_SESSION_F_CONNECTED;
1879 VDBG (0, "session handle %u (%s): connecting to peer %s %U "
1880 "port %d proto %s", session_handle,
1881 vppcom_session_state_str (session->session_state),
1882 session->transport.is_ip4 ? "IPv4" : "IPv6",
1883 format_ip46_address,
1884 &session->transport.rmt_ip, session->transport.is_ip4 ?
1885 IP46_TYPE_IP4 : IP46_TYPE_IP6,
1886 clib_net_to_host_u16 (session->transport.rmt_port),
1887 vppcom_proto_str (session->session_type));
1889 vcl_send_session_connect (wrk, session);
1891 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK))
1893 /* State set to STATE_UPDATED to ensure the session is not assumed
1894 * to be ready and to also allow the app to close it prior to vpp's
1895 * connected reply. */
1896 session->session_state = VCL_STATE_UPDATED;
1897 return VPPCOM_EINPROGRESS;
1901 * Wait for reply from vpp if blocking
1903 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1904 vcm->cfg.session_timeout);
1906 session = vcl_session_get (wrk, session_index);
1907 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1908 session->vpp_handle, rv ? "failed" : "succeeded");
1914 vppcom_session_stream_connect (uint32_t session_handle,
1915 uint32_t parent_session_handle)
1917 vcl_worker_t *wrk = vcl_worker_get_current ();
1918 vcl_session_t *session, *parent_session;
1919 u32 session_index, parent_session_index;
1922 session = vcl_session_get_w_handle (wrk, session_handle);
1924 return VPPCOM_EBADFD;
1925 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1926 if (!parent_session)
1927 return VPPCOM_EBADFD;
1929 session_index = session->session_index;
1930 parent_session_index = parent_session->session_index;
1931 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1933 VDBG (0, "ERROR: cannot connect epoll session %u!",
1934 session->session_index);
1935 return VPPCOM_EBADFD;
1938 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1940 VDBG (0, "session handle %u [0x%llx]: session already "
1941 "connected to session %u [0x%llx] proto %s, state 0x%x (%s)",
1942 session_handle, session->vpp_handle,
1943 parent_session_handle, parent_session->vpp_handle,
1944 vppcom_proto_str (session->session_type), session->session_state,
1945 vppcom_session_state_str (session->session_state));
1949 /* Connect to quic session specifics */
1950 session->transport.is_ip4 = parent_session->transport.is_ip4;
1951 session->transport.rmt_ip.ip4.as_u32 = (uint32_t) 1;
1952 session->transport.rmt_port = 0;
1953 session->parent_handle = parent_session->vpp_handle;
1955 VDBG (0, "session handle %u: connecting to session %u [0x%llx]",
1956 session_handle, parent_session_handle, parent_session->vpp_handle);
1959 * Send connect request and wait for reply from vpp
1961 vcl_send_session_connect (wrk, session);
1962 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1963 vcm->cfg.session_timeout);
1965 session->listener_index = parent_session_index;
1966 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1968 parent_session->n_accepted_sessions++;
1970 session = vcl_session_get (wrk, session_index);
1971 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1972 session->vpp_handle, rv ? "failed" : "succeeded");
1978 vppcom_session_read_internal (uint32_t session_handle, void *buf, int n,
1981 vcl_worker_t *wrk = vcl_worker_get_current ();
1982 int rv, n_read = 0, is_nonblocking;
1983 vcl_session_t *s = 0;
1984 svm_fifo_t *rx_fifo;
1989 if (PREDICT_FALSE (!buf))
1990 return VPPCOM_EFAULT;
1992 s = vcl_session_get_w_handle (wrk, session_handle);
1993 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
1994 return VPPCOM_EBADFD;
1996 if (PREDICT_FALSE (!vcl_session_is_open (s)))
1998 VDBG (0, "session %u[0x%llx] is not open! state 0x%x (%s)",
1999 s->session_index, s->vpp_handle, s->session_state,
2000 vppcom_session_state_str (s->session_state));
2001 return vcl_session_closed_error (s);
2004 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_RD_SHUTDOWN))
2006 /* Vpp would ack the incoming data and enqueue it for reading.
2007 * So even if SHUT_RD is set, we can still read() the data if
2008 * the session is ready.
2010 if (!vcl_session_read_ready (s))
2016 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2017 is_ct = vcl_session_is_ct (s);
2018 mq = wrk->app_event_queue;
2019 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
2020 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2022 if (svm_fifo_is_empty_cons (rx_fifo))
2026 if (vcl_session_is_closing (s))
2027 return vcl_session_closing_error (s);
2029 svm_fifo_unset_event (s->rx_fifo);
2030 svm_fifo_unset_event (rx_fifo);
2031 return VPPCOM_EWOULDBLOCK;
2033 while (svm_fifo_is_empty_cons (rx_fifo))
2035 if (vcl_session_is_closing (s))
2036 return vcl_session_closing_error (s);
2039 svm_fifo_unset_event (s->rx_fifo);
2040 svm_fifo_unset_event (rx_fifo);
2042 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2043 vcl_worker_flush_mq_events (wrk);
2050 rv = app_recv_dgram_raw (rx_fifo, buf, n, &s->transport, 0, peek);
2052 rv = app_recv_stream_raw (rx_fifo, buf, n, 0, peek);
2061 if (svm_fifo_is_empty_cons (rx_fifo))
2064 svm_fifo_unset_event (s->rx_fifo);
2065 svm_fifo_unset_event (rx_fifo);
2066 if (!svm_fifo_is_empty_cons (rx_fifo)
2067 && svm_fifo_set_event (rx_fifo) && is_nonblocking)
2069 vec_add2 (wrk->unhandled_evts_vector, e, 1);
2070 e->event_type = SESSION_IO_EVT_RX;
2071 e->session_index = s->session_index;
2074 else if (PREDICT_FALSE (rv < n && !s->is_dgram))
2076 /* More data enqueued while reading. Try to drain it
2077 * or fill the buffer. Avoid doing that for dgrams */
2083 if (PREDICT_FALSE (svm_fifo_needs_deq_ntf (rx_fifo, n_read)))
2085 svm_fifo_clear_deq_ntf (rx_fifo);
2086 app_send_io_evt_to_vpp (s->vpp_evt_q,
2087 s->rx_fifo->shr->master_session_index,
2088 SESSION_IO_EVT_RX, SVM_Q_WAIT);
2091 VDBG (2, "session %u[0x%llx]: read %d bytes from (%p)", s->session_index,
2092 s->vpp_handle, n_read, rx_fifo);
2098 vppcom_session_read (uint32_t session_handle, void *buf, size_t n)
2100 return (vppcom_session_read_internal (session_handle, buf, n, 0));
2104 vppcom_session_peek (uint32_t session_handle, void *buf, int n)
2106 return (vppcom_session_read_internal (session_handle, buf, n, 1));
2110 vppcom_session_read_segments (uint32_t session_handle,
2111 vppcom_data_segment_t * ds, uint32_t n_segments,
2114 vcl_worker_t *wrk = vcl_worker_get_current ();
2115 int n_read = 0, is_nonblocking;
2116 vcl_session_t *s = 0;
2117 svm_fifo_t *rx_fifo;
2121 s = vcl_session_get_w_handle (wrk, session_handle);
2122 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2123 return VPPCOM_EBADFD;
2125 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2126 return vcl_session_closed_error (s);
2128 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2129 is_ct = vcl_session_is_ct (s);
2130 mq = wrk->app_event_queue;
2131 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
2132 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2134 if (svm_fifo_is_empty_cons (rx_fifo))
2139 svm_fifo_unset_event (s->rx_fifo);
2140 svm_fifo_unset_event (rx_fifo);
2141 return VPPCOM_EWOULDBLOCK;
2143 while (svm_fifo_is_empty_cons (rx_fifo))
2145 if (vcl_session_is_closing (s))
2146 return vcl_session_closing_error (s);
2149 svm_fifo_unset_event (s->rx_fifo);
2150 svm_fifo_unset_event (rx_fifo);
2152 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2153 vcl_worker_flush_mq_events (wrk);
2157 n_read = svm_fifo_segments (rx_fifo, s->rx_bytes_pending,
2158 (svm_fifo_seg_t *) ds, n_segments, max_bytes);
2160 return VPPCOM_EAGAIN;
2162 if (svm_fifo_max_dequeue_cons (rx_fifo) == n_read)
2165 svm_fifo_unset_event (s->rx_fifo);
2166 svm_fifo_unset_event (rx_fifo);
2167 if (svm_fifo_max_dequeue_cons (rx_fifo) != n_read
2168 && svm_fifo_set_event (rx_fifo)
2169 && vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
2172 vec_add2 (wrk->unhandled_evts_vector, e, 1);
2173 e->event_type = SESSION_IO_EVT_RX;
2174 e->session_index = s->session_index;
2178 s->rx_bytes_pending += n_read;
2183 vppcom_session_free_segments (uint32_t session_handle, uint32_t n_bytes)
2185 vcl_worker_t *wrk = vcl_worker_get_current ();
2189 s = vcl_session_get_w_handle (wrk, session_handle);
2190 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2193 is_ct = vcl_session_is_ct (s);
2194 svm_fifo_dequeue_drop (is_ct ? s->ct_rx_fifo : s->rx_fifo, n_bytes);
2196 ASSERT (s->rx_bytes_pending >= n_bytes);
2197 s->rx_bytes_pending -= n_bytes;
2201 vcl_fifo_is_writeable (svm_fifo_t * f, u32 len, u8 is_dgram)
2203 u32 max_enq = svm_fifo_max_enqueue_prod (f);
2205 return max_enq >= (sizeof (session_dgram_hdr_t) + len);
2211 vppcom_session_write_inline (vcl_worker_t * wrk, vcl_session_t * s, void *buf,
2212 size_t n, u8 is_flush, u8 is_dgram)
2214 int n_write, is_nonblocking;
2215 session_evt_type_t et;
2216 svm_fifo_t *tx_fifo;
2220 /* Accept zero length writes but just return */
2221 if (PREDICT_FALSE (!n))
2224 if (PREDICT_FALSE (!buf))
2225 return VPPCOM_EFAULT;
2227 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2229 VDBG (0, "ERROR: session %u [0x%llx]: cannot write to an epoll"
2230 " session!", s->session_index, s->vpp_handle);
2231 return VPPCOM_EBADFD;
2234 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2236 VDBG (1, "session %u [0x%llx]: is not open! state 0x%x (%s)",
2237 s->session_index, s->vpp_handle, s->session_state,
2238 vppcom_session_state_str (s->session_state));
2239 return vcl_session_closed_error (s);;
2242 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_WR_SHUTDOWN))
2244 VDBG (1, "session %u [0x%llx]: is shutdown! state 0x%x (%s)",
2245 s->session_index, s->vpp_handle, s->session_state,
2246 vppcom_session_state_str (s->session_state));
2247 return VPPCOM_EPIPE;
2250 is_ct = vcl_session_is_ct (s);
2251 tx_fifo = is_ct ? s->ct_tx_fifo : s->tx_fifo;
2252 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2254 mq = wrk->app_event_queue;
2255 if (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2259 return VPPCOM_EWOULDBLOCK;
2261 while (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2263 svm_fifo_add_want_deq_ntf (tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
2264 if (vcl_session_is_closing (s))
2265 return vcl_session_closing_error (s);
2267 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2268 vcl_worker_flush_mq_events (wrk);
2272 et = SESSION_IO_EVT_TX;
2273 if (is_flush && !is_ct)
2274 et = SESSION_IO_EVT_TX_FLUSH;
2277 n_write = app_send_dgram_raw (tx_fifo, &s->transport,
2278 s->vpp_evt_q, buf, n, et,
2279 0 /* do_evt */ , SVM_Q_WAIT);
2281 n_write = app_send_stream_raw (tx_fifo, s->vpp_evt_q, buf, n, et,
2282 0 /* do_evt */ , SVM_Q_WAIT);
2284 if (svm_fifo_set_event (s->tx_fifo))
2285 app_send_io_evt_to_vpp (
2286 s->vpp_evt_q, s->tx_fifo->shr->master_session_index, et, SVM_Q_WAIT);
2288 /* The underlying fifo segment can run out of memory */
2289 if (PREDICT_FALSE (n_write < 0))
2290 return VPPCOM_EAGAIN;
2292 VDBG (2, "session %u [0x%llx]: wrote %d bytes", s->session_index,
2293 s->vpp_handle, n_write);
2299 vppcom_session_write (uint32_t session_handle, void *buf, size_t n)
2301 vcl_worker_t *wrk = vcl_worker_get_current ();
2304 s = vcl_session_get_w_handle (wrk, session_handle);
2305 if (PREDICT_FALSE (!s))
2306 return VPPCOM_EBADFD;
2308 return vppcom_session_write_inline (wrk, s, buf, n,
2309 0 /* is_flush */ , s->is_dgram ? 1 : 0);
2313 vppcom_session_write_msg (uint32_t session_handle, void *buf, size_t n)
2315 vcl_worker_t *wrk = vcl_worker_get_current ();
2318 s = vcl_session_get_w_handle (wrk, session_handle);
2319 if (PREDICT_FALSE (!s))
2320 return VPPCOM_EBADFD;
2322 return vppcom_session_write_inline (wrk, s, buf, n,
2323 1 /* is_flush */ , s->is_dgram ? 1 : 0);
2326 #define vcl_fifo_rx_evt_valid_or_break(_s) \
2327 if (PREDICT_FALSE (!_s->rx_fifo)) \
2329 if (PREDICT_FALSE (svm_fifo_is_empty (_s->rx_fifo))) \
2331 if (!vcl_session_is_ct (_s)) \
2333 svm_fifo_unset_event (_s->rx_fifo); \
2334 if (svm_fifo_is_empty (_s->rx_fifo)) \
2337 else if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2339 svm_fifo_unset_event (_s->rx_fifo); /* rx evts on actual fifo*/ \
2340 if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2346 vcl_select_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2347 unsigned long n_bits, unsigned long *read_map,
2348 unsigned long *write_map,
2349 unsigned long *except_map, u32 * bits_set)
2351 session_disconnected_msg_t *disconnected_msg;
2352 session_connected_msg_t *connected_msg;
2356 switch (e->event_type)
2358 case SESSION_IO_EVT_RX:
2359 sid = e->session_index;
2360 s = vcl_session_get (wrk, sid);
2361 if (!s || !vcl_session_is_open (s))
2363 vcl_fifo_rx_evt_valid_or_break (s);
2364 if (sid < n_bits && read_map)
2366 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2370 case SESSION_IO_EVT_TX:
2371 sid = e->session_index;
2372 s = vcl_session_get (wrk, sid);
2373 if (!s || !vcl_session_is_open (s))
2375 if (sid < n_bits && write_map)
2377 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2381 case SESSION_CTRL_EVT_ACCEPTED:
2383 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
2385 s = vcl_session_get (wrk, e->session_index);
2388 sid = s->session_index;
2389 if (sid < n_bits && read_map)
2391 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2395 case SESSION_CTRL_EVT_CONNECTED:
2398 connected_msg = (session_connected_msg_t *) e->data;
2399 sid = vcl_session_connected_handler (wrk, connected_msg);
2402 sid = e->session_index;
2403 if (sid == VCL_INVALID_SESSION_INDEX)
2405 if (sid < n_bits && write_map)
2407 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2411 case SESSION_CTRL_EVT_DISCONNECTED:
2412 disconnected_msg = (session_disconnected_msg_t *) e->data;
2413 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
2416 sid = s->session_index;
2417 if (sid < n_bits && except_map)
2419 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2423 case SESSION_CTRL_EVT_RESET:
2424 sid = vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
2425 if (sid < n_bits && except_map)
2427 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2431 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
2432 vcl_session_unlisten_reply_handler (wrk, e->data);
2434 case SESSION_CTRL_EVT_MIGRATED:
2435 vcl_session_migrated_handler (wrk, e->data);
2437 case SESSION_CTRL_EVT_CLEANUP:
2438 vcl_session_cleanup_handler (wrk, e->data);
2440 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
2441 vcl_session_worker_update_reply_handler (wrk, e->data);
2443 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
2444 vcl_session_req_worker_update_handler (wrk, e->data);
2446 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
2447 vcl_session_app_add_segment_handler (wrk, e->data);
2449 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
2450 vcl_session_app_del_segment_handler (wrk, e->data);
2452 case SESSION_CTRL_EVT_APP_WRK_RPC:
2453 vcl_worker_rpc_handler (wrk, e->data);
2456 clib_warning ("unhandled: %u", e->event_type);
2462 vcl_select_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
2463 unsigned long n_bits, unsigned long *read_map,
2464 unsigned long *write_map, unsigned long *except_map,
2465 double time_to_wait, u32 * bits_set)
2467 svm_msg_q_msg_t *msg;
2471 if (svm_msg_q_is_empty (mq))
2478 else if (time_to_wait < 0)
2479 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2482 if (svm_msg_q_timedwait (mq, time_to_wait))
2486 vcl_mq_dequeue_batch (wrk, mq, ~0);
2488 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
2490 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
2491 e = svm_msg_q_msg_data (mq, msg);
2492 vcl_select_handle_mq_event (wrk, e, n_bits, read_map, write_map,
2493 except_map, bits_set);
2494 svm_msg_q_free_msg (mq, msg);
2496 vec_reset_length (wrk->mq_msg_vector);
2497 vcl_handle_pending_wrk_updates (wrk);
2502 vppcom_select_condvar (vcl_worker_t * wrk, int n_bits,
2503 vcl_si_set * read_map, vcl_si_set * write_map,
2504 vcl_si_set * except_map, double time_to_wait,
2507 double wait = 0, start = 0;
2511 wait = time_to_wait;
2512 start = clib_time_now (&wrk->clib_time);
2517 vcl_select_handle_mq (wrk, wrk->app_event_queue, n_bits, read_map,
2518 write_map, except_map, wait, bits_set);
2524 wait = wait - (clib_time_now (&wrk->clib_time) - start);
2532 vppcom_select_eventfd (vcl_worker_t * wrk, int n_bits,
2533 vcl_si_set * read_map, vcl_si_set * write_map,
2534 vcl_si_set * except_map, double time_to_wait,
2537 vcl_mq_evt_conn_t *mqc;
2538 int __clib_unused n_read;
2542 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
2543 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
2544 vec_len (wrk->mq_events), time_to_wait);
2545 for (i = 0; i < n_mq_evts; i++)
2547 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
2548 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
2549 vcl_select_handle_mq (wrk, mqc->mq, n_bits, read_map, write_map,
2550 except_map, 0, bits_set);
2553 return (n_mq_evts > 0 ? (int) *bits_set : 0);
2557 vppcom_select (int n_bits, vcl_si_set * read_map, vcl_si_set * write_map,
2558 vcl_si_set * except_map, double time_to_wait)
2560 u32 sid, minbits = clib_max (n_bits, BITS (uword)), bits_set = 0;
2561 vcl_worker_t *wrk = vcl_worker_get_current ();
2562 vcl_session_t *s = 0;
2565 if (n_bits && read_map)
2567 clib_bitmap_validate (wrk->rd_bitmap, minbits);
2568 clib_memcpy_fast (wrk->rd_bitmap, read_map,
2569 vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2570 memset (read_map, 0, vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2572 if (n_bits && write_map)
2574 clib_bitmap_validate (wrk->wr_bitmap, minbits);
2575 clib_memcpy_fast (wrk->wr_bitmap, write_map,
2576 vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2577 memset (write_map, 0, vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2579 if (n_bits && except_map)
2581 clib_bitmap_validate (wrk->ex_bitmap, minbits);
2582 clib_memcpy_fast (wrk->ex_bitmap, except_map,
2583 vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2584 memset (except_map, 0, vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2593 clib_bitmap_foreach (sid, wrk->wr_bitmap)
2595 if (!(s = vcl_session_get (wrk, sid)))
2597 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2602 if (vcl_session_write_ready (s))
2604 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2609 svm_fifo_t *txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2610 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF);
2618 clib_bitmap_foreach (sid, wrk->rd_bitmap)
2620 if (!(s = vcl_session_get (wrk, sid)))
2622 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2627 if (vcl_session_read_ready (s))
2629 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2636 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
2638 vcl_select_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i], n_bits,
2639 read_map, write_map, except_map, &bits_set);
2641 vec_reset_length (wrk->unhandled_evts_vector);
2643 if (vcm->cfg.use_mq_eventfd)
2644 vppcom_select_eventfd (wrk, n_bits, read_map, write_map, except_map,
2645 time_to_wait, &bits_set);
2647 vppcom_select_condvar (wrk, n_bits, read_map, write_map, except_map,
2648 time_to_wait, &bits_set);
2654 vep_verify_epoll_chain (vcl_worker_t * wrk, u32 vep_handle)
2656 vppcom_epoll_t *vep;
2657 u32 sh = vep_handle;
2660 if (VPPCOM_DEBUG <= 2)
2663 s = vcl_session_get_w_handle (wrk, vep_handle);
2664 if (PREDICT_FALSE (!s))
2666 VDBG (0, "ERROR: Invalid vep_sh (%u)!", vep_handle);
2669 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP)))
2671 VDBG (0, "ERROR: vep_sh (%u) is not a vep!", vep_handle);
2675 VDBG (0, "vep_sh (%u): Dumping epoll chain\n"
2678 " is_vep_session = %u\n"
2679 " next_sh = 0x%x (%u)\n"
2680 "}\n", vep_handle, s->flags & VCL_SESSION_F_IS_VEP,
2681 s->flags & VCL_SESSION_F_IS_VEP_SESSION, vep->next_sh, vep->next_sh);
2683 for (sh = vep->next_sh; sh != ~0; sh = vep->next_sh)
2685 s = vcl_session_get_w_handle (wrk, sh);
2686 if (PREDICT_FALSE (!s))
2688 VDBG (0, "ERROR: Invalid sh (%u)!", sh);
2691 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2693 VDBG (0, "ERROR: sh (%u) is a vep!", vep_handle);
2695 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2697 VDBG (0, "ERROR: sh (%u) is not a vep session handle!", sh);
2701 if (PREDICT_FALSE (vep->vep_sh != vep_handle))
2702 VDBG (0, "ERROR: session (%u) vep_sh (%u) != vep_sh (%u)!",
2703 sh, s->vep.vep_sh, vep_handle);
2704 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2706 VDBG (0, "vep_sh[%u]: sh 0x%x (%u)\n"
2708 " next_sh = 0x%x (%u)\n"
2709 " prev_sh = 0x%x (%u)\n"
2710 " vep_sh = 0x%x (%u)\n"
2711 " ev.events = 0x%x\n"
2712 " ev.data.u64 = 0x%llx\n"
2715 vep_handle, sh, sh, vep->next_sh, vep->next_sh, vep->prev_sh,
2716 vep->prev_sh, vep->vep_sh, vep->vep_sh, vep->ev.events,
2717 vep->ev.data.u64, vep->et_mask);
2722 VDBG (0, "vep_sh (%u): Dump complete!\n", vep_handle);
2726 vppcom_epoll_create (void)
2728 vcl_worker_t *wrk = vcl_worker_get_current ();
2729 vcl_session_t *vep_session;
2731 vep_session = vcl_session_alloc (wrk);
2733 vep_session->flags |= VCL_SESSION_F_IS_VEP;
2734 vep_session->vep.vep_sh = ~0;
2735 vep_session->vep.next_sh = ~0;
2736 vep_session->vep.prev_sh = ~0;
2737 vep_session->vpp_handle = ~0;
2739 vcl_evt (VCL_EVT_EPOLL_CREATE, vep_session, vep_session->session_index);
2740 VDBG (0, "Created vep_idx %u", vep_session->session_index);
2742 return vcl_session_handle (vep_session);
2746 vppcom_epoll_ctl (uint32_t vep_handle, int op, uint32_t session_handle,
2747 struct epoll_event *event)
2749 vcl_worker_t *wrk = vcl_worker_get_current ();
2750 int rv = VPPCOM_OK, add_evt = 0;
2751 vcl_session_t *vep_session;
2755 if (vep_handle == session_handle)
2757 VDBG (0, "vep_sh == session handle (%u)!", vep_handle);
2758 return VPPCOM_EINVAL;
2761 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
2762 if (PREDICT_FALSE (!vep_session))
2764 VDBG (0, "Invalid vep_sh (%u)!", vep_handle);
2765 return VPPCOM_EBADFD;
2767 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
2769 VDBG (0, "vep_sh (%u) is not a vep!", vep_handle);
2770 return VPPCOM_EINVAL;
2773 ASSERT (vep_session->vep.vep_sh == ~0);
2774 ASSERT (vep_session->vep.prev_sh == ~0);
2776 s = vcl_session_get_w_handle (wrk, session_handle);
2777 if (PREDICT_FALSE (!s))
2779 VDBG (0, "Invalid session_handle (%u)!", session_handle);
2780 return VPPCOM_EBADFD;
2782 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2784 VDBG (0, "session_handle (%u) is a vep!", vep_handle);
2785 return VPPCOM_EINVAL;
2791 if (PREDICT_FALSE (!event))
2793 VDBG (0, "EPOLL_CTL_ADD: NULL pointer to epoll_event structure!");
2794 return VPPCOM_EINVAL;
2796 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2798 VDBG (0, "EPOLL_CTL_ADD: %u already epolled!", s->session_index);
2802 if (vep_session->vep.next_sh != ~0)
2804 vcl_session_t *next_session;
2805 next_session = vcl_session_get_w_handle (wrk,
2806 vep_session->vep.next_sh);
2807 if (PREDICT_FALSE (!next_session))
2809 VDBG (0, "EPOLL_CTL_ADD: Invalid vep.next_sh (%u) on "
2810 "vep_idx (%u)!", vep_session->vep.next_sh, vep_handle);
2811 return VPPCOM_EBADFD;
2813 ASSERT (next_session->vep.prev_sh == vep_handle);
2814 next_session->vep.prev_sh = session_handle;
2816 s->vep.next_sh = vep_session->vep.next_sh;
2817 s->vep.prev_sh = vep_handle;
2818 s->vep.vep_sh = vep_handle;
2819 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2820 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
2822 s->flags &= ~VCL_SESSION_F_IS_VEP;
2823 s->flags |= VCL_SESSION_F_IS_VEP_SESSION;
2824 vep_session->vep.next_sh = session_handle;
2826 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2827 if (txf && (event->events & EPOLLOUT))
2828 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2830 /* Generate EPOLLOUT if tx fifo not full */
2831 if ((event->events & EPOLLOUT) && (vcl_session_write_ready (s) > 0))
2833 session_event_t e = { 0 };
2834 e.event_type = SESSION_IO_EVT_TX;
2835 e.session_index = s->session_index;
2836 vec_add1 (wrk->unhandled_evts_vector, e);
2839 /* Generate EPOLLIN if rx fifo has data */
2840 if ((event->events & EPOLLIN) && (vcl_session_read_ready (s) > 0))
2842 session_event_t e = { 0 };
2843 e.event_type = SESSION_IO_EVT_RX;
2844 e.session_index = s->session_index;
2845 vec_add1 (wrk->unhandled_evts_vector, e);
2846 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2849 if (!add_evt && vcl_session_is_closing (s))
2851 session_event_t e = { 0 };
2852 if (s->session_state == VCL_STATE_VPP_CLOSING)
2853 e.event_type = SESSION_CTRL_EVT_DISCONNECTED;
2855 e.event_type = SESSION_CTRL_EVT_RESET;
2856 e.session_index = s->session_index;
2858 vec_add1 (wrk->unhandled_evts_vector, e);
2860 VDBG (1, "EPOLL_CTL_ADD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2861 vep_handle, session_handle, event->events, event->data.u64);
2862 vcl_evt (VCL_EVT_EPOLL_CTLADD, s, event->events, event->data.u64);
2866 if (PREDICT_FALSE (!event))
2868 VDBG (0, "EPOLL_CTL_MOD: NULL pointer to epoll_event structure!");
2872 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2874 VDBG (0, "sh %u EPOLL_CTL_MOD: not a vep session!", session_handle);
2878 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2880 VDBG (0, "EPOLL_CTL_MOD: sh %u vep_sh (%u) != vep_sh (%u)!",
2881 session_handle, s->vep.vep_sh, vep_handle);
2886 /* Generate EPOLLOUT if session write ready nd event was not on */
2887 if ((event->events & EPOLLOUT) && !(s->vep.ev.events & EPOLLOUT) &&
2888 (vcl_session_write_ready (s) > 0))
2890 session_event_t e = { 0 };
2891 e.event_type = SESSION_IO_EVT_TX;
2892 e.session_index = s->session_index;
2893 vec_add1 (wrk->unhandled_evts_vector, e);
2895 /* Generate EPOLLIN if session read ready and event was not on */
2896 if ((event->events & EPOLLIN) && !(s->vep.ev.events & EPOLLIN) &&
2897 (vcl_session_read_ready (s) > 0))
2899 session_event_t e = { 0 };
2900 e.event_type = SESSION_IO_EVT_RX;
2901 e.session_index = s->session_index;
2902 vec_add1 (wrk->unhandled_evts_vector, e);
2903 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2905 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2907 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2910 if (event->events & EPOLLOUT)
2911 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2913 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2915 VDBG (1, "EPOLL_CTL_MOD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2916 vep_handle, session_handle, event->events, event->data.u64);
2920 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2922 VDBG (0, "EPOLL_CTL_DEL: %u not a vep session!", session_handle);
2926 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2928 VDBG (0, "EPOLL_CTL_DEL: sh %u vep_sh (%u) != vep_sh (%u)!",
2929 session_handle, s->vep.vep_sh, vep_handle);
2934 if (s->vep.prev_sh == vep_handle)
2935 vep_session->vep.next_sh = s->vep.next_sh;
2938 vcl_session_t *prev_session;
2939 prev_session = vcl_session_get_w_handle (wrk, s->vep.prev_sh);
2940 if (PREDICT_FALSE (!prev_session))
2942 VDBG (0, "EPOLL_CTL_DEL: Invalid prev_sh (%u) on sh (%u)!",
2943 s->vep.prev_sh, session_handle);
2944 return VPPCOM_EBADFD;
2946 ASSERT (prev_session->vep.next_sh == session_handle);
2947 prev_session->vep.next_sh = s->vep.next_sh;
2949 if (s->vep.next_sh != ~0)
2951 vcl_session_t *next_session;
2952 next_session = vcl_session_get_w_handle (wrk, s->vep.next_sh);
2953 if (PREDICT_FALSE (!next_session))
2955 VDBG (0, "EPOLL_CTL_DEL: Invalid next_sh (%u) on sh (%u)!",
2956 s->vep.next_sh, session_handle);
2957 return VPPCOM_EBADFD;
2959 ASSERT (next_session->vep.prev_sh == session_handle);
2960 next_session->vep.prev_sh = s->vep.prev_sh;
2963 if (s->vep.lt_next != VCL_INVALID_SESSION_INDEX)
2964 vcl_epoll_lt_del (wrk, s);
2966 memset (&s->vep, 0, sizeof (s->vep));
2967 s->vep.next_sh = ~0;
2968 s->vep.prev_sh = ~0;
2970 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
2971 s->flags &= ~VCL_SESSION_F_IS_VEP_SESSION;
2973 if (vcl_session_is_open (s))
2975 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2977 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2980 VDBG (1, "EPOLL_CTL_DEL: vep_idx %u, sh %u!", vep_handle,
2982 vcl_evt (VCL_EVT_EPOLL_CTLDEL, s, vep_sh);
2986 VDBG (0, "Invalid operation (%d)!", op);
2990 vep_verify_epoll_chain (wrk, vep_handle);
2997 vcl_epoll_wait_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2998 struct epoll_event *events, u32 * num_ev)
3000 session_disconnected_msg_t *disconnected_msg;
3001 session_connected_msg_t *connected_msg;
3002 u32 sid = ~0, session_events;
3003 u64 session_evt_data = ~0;
3007 switch (e->event_type)
3009 case SESSION_IO_EVT_RX:
3010 sid = e->session_index;
3011 s = vcl_session_get (wrk, sid);
3012 if (vcl_session_is_closed (s))
3014 vcl_fifo_rx_evt_valid_or_break (s);
3015 session_events = s->vep.ev.events;
3016 if (!(EPOLLIN & s->vep.ev.events) ||
3017 (s->flags & VCL_SESSION_F_HAS_RX_EVT) ||
3018 (s->vep.lt_next != VCL_INVALID_SESSION_INDEX))
3021 events[*num_ev].events = EPOLLIN;
3022 session_evt_data = s->vep.ev.data.u64;
3023 s->flags |= VCL_SESSION_F_HAS_RX_EVT;
3025 case SESSION_IO_EVT_TX:
3026 sid = e->session_index;
3027 s = vcl_session_get (wrk, sid);
3028 if (vcl_session_is_closed (s))
3030 session_events = s->vep.ev.events;
3031 if (!(EPOLLOUT & session_events))
3034 events[*num_ev].events = EPOLLOUT;
3035 session_evt_data = s->vep.ev.data.u64;
3036 svm_fifo_reset_has_deq_ntf (vcl_session_is_ct (s) ?
3037 s->ct_tx_fifo : s->tx_fifo);
3039 case SESSION_CTRL_EVT_ACCEPTED:
3041 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
3043 s = vcl_session_get (wrk, e->session_index);
3046 session_events = s->vep.ev.events;
3047 sid = s->session_index;
3048 if (!(EPOLLIN & session_events) ||
3049 (s->vep.lt_next != VCL_INVALID_SESSION_INDEX))
3052 events[*num_ev].events = EPOLLIN;
3053 session_evt_data = s->vep.ev.data.u64;
3055 case SESSION_CTRL_EVT_CONNECTED:
3058 connected_msg = (session_connected_msg_t *) e->data;
3059 sid = vcl_session_connected_handler (wrk, connected_msg);
3062 sid = e->session_index;
3063 s = vcl_session_get (wrk, sid);
3064 if (vcl_session_is_closed (s))
3066 session_events = s->vep.ev.events;
3067 /* Generate EPOLLOUT because there's no connected event */
3068 if (!(EPOLLOUT & session_events))
3071 events[*num_ev].events = EPOLLOUT;
3072 session_evt_data = s->vep.ev.data.u64;
3073 if (s->session_state == VCL_STATE_DETACHED)
3074 events[*num_ev].events |= EPOLLHUP;
3076 case SESSION_CTRL_EVT_DISCONNECTED:
3079 disconnected_msg = (session_disconnected_msg_t *) e->data;
3080 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
3084 s = vcl_session_get (wrk, e->session_index);
3086 if (vcl_session_is_closed (s) ||
3087 !(s->flags & VCL_SESSION_F_IS_VEP_SESSION))
3089 sid = s->session_index;
3090 session_events = s->vep.ev.events;
3092 if (EPOLLRDHUP & session_events)
3094 /* If app can distinguish between RDHUP and HUP,
3095 * we make finer control */
3096 events[*num_ev].events = EPOLLRDHUP;
3097 if (s->flags & VCL_SESSION_F_WR_SHUTDOWN)
3099 events[*num_ev].events |= EPOLLHUP;
3104 events[*num_ev].events = EPOLLHUP;
3106 session_evt_data = s->vep.ev.data.u64;
3109 case SESSION_CTRL_EVT_RESET:
3111 sid = vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
3113 sid = e->session_index;
3114 s = vcl_session_get (wrk, sid);
3115 if (vcl_session_is_closed (s) ||
3116 !(s->flags & VCL_SESSION_F_IS_VEP_SESSION))
3118 session_events = s->vep.ev.events;
3120 events[*num_ev].events = EPOLLHUP | EPOLLRDHUP;
3121 session_evt_data = s->vep.ev.data.u64;
3123 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
3124 vcl_session_unlisten_reply_handler (wrk, e->data);
3126 case SESSION_CTRL_EVT_MIGRATED:
3127 vcl_session_migrated_handler (wrk, e->data);
3129 case SESSION_CTRL_EVT_CLEANUP:
3130 vcl_session_cleanup_handler (wrk, e->data);
3132 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
3133 vcl_session_req_worker_update_handler (wrk, e->data);
3135 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
3136 vcl_session_worker_update_reply_handler (wrk, e->data);
3138 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
3139 vcl_session_app_add_segment_handler (wrk, e->data);
3141 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
3142 vcl_session_app_del_segment_handler (wrk, e->data);
3144 case SESSION_CTRL_EVT_APP_WRK_RPC:
3145 vcl_worker_rpc_handler (wrk, e->data);
3148 VDBG (0, "unhandled: %u", e->event_type);
3154 events[*num_ev].data.u64 = session_evt_data;
3155 if (EPOLLONESHOT & session_events)
3157 s = vcl_session_get (wrk, sid);
3158 s->vep.ev.events = 0;
3160 else if (!(EPOLLET & session_events))
3162 s = vcl_session_get (wrk, sid);
3163 if (s->vep.lt_next == VCL_INVALID_SESSION_INDEX)
3164 vcl_epoll_lt_add (wrk, s);
3171 vcl_epoll_wait_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
3172 struct epoll_event *events, u32 maxevents,
3173 double wait_for_time, u32 * num_ev)
3175 svm_msg_q_msg_t *msg;
3179 if (vec_len (wrk->mq_msg_vector) && svm_msg_q_is_empty (mq))
3180 goto handle_dequeued;
3182 if (svm_msg_q_is_empty (mq))
3186 else if (wait_for_time < 0)
3187 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
3190 if (svm_msg_q_timedwait (mq, wait_for_time / 1e3))
3194 ASSERT (maxevents > *num_ev);
3195 vcl_mq_dequeue_batch (wrk, mq, ~0);
3198 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
3200 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
3201 e = svm_msg_q_msg_data (mq, msg);
3202 if (*num_ev < maxevents)
3203 vcl_epoll_wait_handle_mq_event (wrk, e, events, num_ev);
3205 vcl_handle_mq_event (wrk, e);
3206 svm_msg_q_free_msg (mq, msg);
3208 vec_reset_length (wrk->mq_msg_vector);
3209 vcl_handle_pending_wrk_updates (wrk);
3214 vppcom_epoll_wait_condvar (vcl_worker_t *wrk, struct epoll_event *events,
3215 int maxevents, u32 n_evts, double timeout_ms)
3222 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3227 vcl_epoll_wait_handle_mq (wrk, wrk->app_event_queue, events, maxevents,
3228 timeout_ms, &n_evts);
3229 if (n_evts || !timeout_ms)
3232 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3238 vppcom_epoll_wait_eventfd (vcl_worker_t *wrk, struct epoll_event *events,
3239 int maxevents, u32 n_evts, double timeout_ms)
3241 int __clib_unused n_read;
3242 vcl_mq_evt_conn_t *mqc;
3247 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
3251 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3256 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
3257 vec_len (wrk->mq_events), timeout_ms);
3260 VDBG (0, "epoll_wait error %u", errno);
3264 for (i = 0; i < n_mq_evts; i++)
3266 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
3267 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
3268 vcl_epoll_wait_handle_mq (wrk, mqc->mq, events, maxevents, 0,
3272 if (n_evts || !timeout_ms)
3275 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3281 vcl_epoll_wait_handle_lt (vcl_worker_t *wrk, struct epoll_event *events,
3282 int maxevents, u32 *n_evts)
3284 u32 add_event = 0, next;
3289 ASSERT (wrk->ep_lt_current != VCL_INVALID_SESSION_INDEX);
3290 if (*n_evts >= maxevents)
3293 next = wrk->ep_lt_current;
3296 s = vcl_session_get (wrk, next);
3297 next = s->vep.lt_next;
3299 if ((s->vep.ev.events & EPOLLIN) && (rv = vcl_session_read_ready (s)))
3302 events[*n_evts].events |= rv > 0 ? EPOLLIN : EPOLLHUP | EPOLLRDHUP;
3303 evt_data = s->vep.ev.data.u64;
3305 if ((s->vep.ev.events & EPOLLOUT) && (rv = vcl_session_write_ready (s)))
3308 events[*n_evts].events |= rv > 0 ? EPOLLOUT : EPOLLHUP | EPOLLRDHUP;
3309 evt_data = s->vep.ev.data.u64;
3311 if (!add_event && s->session_state > VCL_STATE_READY)
3314 events[*n_evts].events |= EPOLLHUP | EPOLLRDHUP;
3315 evt_data = s->vep.ev.data.u64;
3319 events[*n_evts].data.u64 = evt_data;
3322 if (EPOLLONESHOT & s->vep.ev.events)
3323 s->vep.ev.events = 0;
3324 if (*n_evts == maxevents)
3326 wrk->ep_lt_current = next;
3332 vcl_epoll_lt_del (wrk, s);
3333 if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX)
3337 while (next != wrk->ep_lt_current);
3341 vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
3342 int maxevents, double wait_for_time)
3344 vcl_worker_t *wrk = vcl_worker_get_current ();
3345 vcl_session_t *vep_session;
3349 if (PREDICT_FALSE (maxevents <= 0))
3351 VDBG (0, "ERROR: Invalid maxevents (%d)!", maxevents);
3352 return VPPCOM_EINVAL;
3355 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
3357 return VPPCOM_EBADFD;
3359 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
3361 VDBG (0, "ERROR: vep_idx (%u) is not a vep!", vep_handle);
3362 return VPPCOM_EINVAL;
3365 if (vec_len (wrk->unhandled_evts_vector))
3367 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
3369 vcl_epoll_wait_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i],
3371 if (n_evts == maxevents)
3373 vec_delete (wrk->unhandled_evts_vector, i + 1, 0);
3377 vec_reset_length (wrk->unhandled_evts_vector);
3380 if (PREDICT_FALSE (wrk->ep_lt_current != VCL_INVALID_SESSION_INDEX))
3381 vcl_epoll_wait_handle_lt (wrk, events, maxevents, &n_evts);
3383 /* Request to only drain unhandled */
3384 if ((int) wait_for_time == -2)
3388 if (vcm->cfg.use_mq_eventfd)
3389 n_evts = vppcom_epoll_wait_eventfd (wrk, events, maxevents, n_evts,
3392 n_evts = vppcom_epoll_wait_condvar (wrk, events, maxevents, n_evts,
3399 vppcom_session_attr (uint32_t session_handle, uint32_t op,
3400 void *buffer, uint32_t * buflen)
3402 vcl_worker_t *wrk = vcl_worker_get_current ();
3403 u32 *flags = buffer;
3404 vppcom_endpt_t *ep = buffer;
3405 transport_endpt_attr_t tea;
3406 vcl_session_t *session;
3409 session = vcl_session_get_w_handle (wrk, session_handle);
3411 return VPPCOM_EBADFD;
3415 case VPPCOM_ATTR_GET_NREAD:
3416 rv = vcl_session_read_ready (session);
3417 VDBG (2, "VPPCOM_ATTR_GET_NREAD: sh %u, nread = %d", session_handle,
3421 case VPPCOM_ATTR_GET_NWRITE:
3422 rv = vcl_session_write_ready (session);
3423 VDBG (2, "VPPCOM_ATTR_GET_NWRITE: sh %u, nwrite = %d", session_handle,
3427 case VPPCOM_ATTR_GET_FLAGS:
3428 if (PREDICT_TRUE (buffer && buflen && (*buflen >= sizeof (*flags))))
3432 (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK) ?
3434 *buflen = sizeof (*flags);
3435 VDBG (2, "VPPCOM_ATTR_GET_FLAGS: sh %u, flags = 0x%08x, "
3436 "is_nonblocking = %u", session_handle, *flags,
3437 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3443 case VPPCOM_ATTR_SET_FLAGS:
3444 if (PREDICT_TRUE (buffer && buflen && (*buflen == sizeof (*flags))))
3446 if (*flags & O_NONBLOCK)
3447 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
3449 vcl_session_clear_attr (session, VCL_SESS_ATTR_NONBLOCK);
3451 VDBG (2, "VPPCOM_ATTR_SET_FLAGS: sh %u, flags = 0x%08x,"
3452 " is_nonblocking = %u", session_handle, *flags,
3453 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3459 case VPPCOM_ATTR_GET_PEER_ADDR:
3460 if (PREDICT_TRUE (buffer && buflen &&
3461 (*buflen >= sizeof (*ep)) && ep->ip))
3463 ep->is_ip4 = session->transport.is_ip4;
3464 ep->port = session->transport.rmt_port;
3465 if (session->transport.is_ip4)
3466 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
3467 sizeof (ip4_address_t));
3469 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
3470 sizeof (ip6_address_t));
3471 *buflen = sizeof (*ep);
3472 VDBG (1, "VPPCOM_ATTR_GET_PEER_ADDR: sh %u, is_ip4 = %u, "
3473 "addr = %U, port %u", session_handle, ep->is_ip4,
3474 format_ip46_address, &session->transport.rmt_ip,
3475 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3476 clib_net_to_host_u16 (ep->port));
3482 case VPPCOM_ATTR_GET_LCL_ADDR:
3483 if (PREDICT_TRUE (buffer && buflen &&
3484 (*buflen >= sizeof (*ep)) && ep->ip))
3486 ep->is_ip4 = session->transport.is_ip4;
3487 ep->port = session->transport.lcl_port;
3488 if (session->transport.is_ip4)
3489 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip4,
3490 sizeof (ip4_address_t));
3492 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip6,
3493 sizeof (ip6_address_t));
3494 *buflen = sizeof (*ep);
3495 VDBG (1, "VPPCOM_ATTR_GET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3496 " port %d", session_handle, ep->is_ip4, format_ip46_address,
3497 &session->transport.lcl_ip,
3498 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3499 clib_net_to_host_u16 (ep->port));
3505 case VPPCOM_ATTR_SET_LCL_ADDR:
3506 if (PREDICT_TRUE (buffer && buflen &&
3507 (*buflen >= sizeof (*ep)) && ep->ip))
3509 session->transport.is_ip4 = ep->is_ip4;
3510 session->transport.lcl_port = ep->port;
3511 vcl_ip_copy_from_ep (&session->transport.lcl_ip, ep);
3512 *buflen = sizeof (*ep);
3513 VDBG (1, "VPPCOM_ATTR_SET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3514 " port %d", session_handle, ep->is_ip4, format_ip46_address,
3515 &session->transport.lcl_ip,
3516 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3517 clib_net_to_host_u16 (ep->port));
3523 case VPPCOM_ATTR_GET_LIBC_EPFD:
3524 rv = session->libc_epfd;
3525 VDBG (2, "VPPCOM_ATTR_GET_LIBC_EPFD: libc_epfd %d", rv);
3528 case VPPCOM_ATTR_SET_LIBC_EPFD:
3529 if (PREDICT_TRUE (buffer && buflen &&
3530 (*buflen == sizeof (session->libc_epfd))))
3532 session->libc_epfd = *(int *) buffer;
3533 *buflen = sizeof (session->libc_epfd);
3535 VDBG (2, "VPPCOM_ATTR_SET_LIBC_EPFD: libc_epfd %d, buflen %d",
3536 session->libc_epfd, *buflen);
3542 case VPPCOM_ATTR_GET_PROTOCOL:
3543 if (buffer && buflen && (*buflen >= sizeof (int)))
3545 *(int *) buffer = session->session_type;
3546 *buflen = sizeof (int);
3548 VDBG (2, "VPPCOM_ATTR_GET_PROTOCOL: %d (%s), buflen %d",
3549 *(int *) buffer, *(int *) buffer ? "UDP" : "TCP", *buflen);
3555 case VPPCOM_ATTR_GET_LISTEN:
3556 if (buffer && buflen && (*buflen >= sizeof (int)))
3558 *(int *) buffer = vcl_session_has_attr (session,
3559 VCL_SESS_ATTR_LISTEN);
3560 *buflen = sizeof (int);
3562 VDBG (2, "VPPCOM_ATTR_GET_LISTEN: %d, buflen %d", *(int *) buffer,
3569 case VPPCOM_ATTR_GET_ERROR:
3570 if (buffer && buflen && (*buflen >= sizeof (int)))
3572 *(int *) buffer = 0;
3573 *buflen = sizeof (int);
3575 VDBG (2, "VPPCOM_ATTR_GET_ERROR: %d, buflen %d, #VPP-TBD#",
3576 *(int *) buffer, *buflen);
3582 case VPPCOM_ATTR_GET_TX_FIFO_LEN:
3583 if (buffer && buflen && (*buflen >= sizeof (u32)))
3587 *(size_t *) buffer = (session->sndbuf_size ? session->sndbuf_size :
3589 svm_fifo_size (session->tx_fifo) :
3590 vcm->cfg.tx_fifo_size);
3591 *buflen = sizeof (u32);
3593 VDBG (2, "VPPCOM_ATTR_GET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3594 " #VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer,
3601 case VPPCOM_ATTR_SET_TX_FIFO_LEN:
3602 if (buffer && buflen && (*buflen == sizeof (u32)))
3605 session->sndbuf_size = *(u32 *) buffer;
3606 VDBG (2, "VPPCOM_ATTR_SET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3607 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3614 case VPPCOM_ATTR_GET_RX_FIFO_LEN:
3615 if (buffer && buflen && (*buflen >= sizeof (u32)))
3619 *(size_t *) buffer = (session->rcvbuf_size ? session->rcvbuf_size :
3621 svm_fifo_size (session->rx_fifo) :
3622 vcm->cfg.rx_fifo_size);
3623 *buflen = sizeof (u32);
3625 VDBG (2, "VPPCOM_ATTR_GET_RX_FIFO_LEN: %u (0x%x), buflen %d, "
3626 "#VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer, *buflen);
3632 case VPPCOM_ATTR_SET_RX_FIFO_LEN:
3633 if (buffer && buflen && (*buflen == sizeof (u32)))
3636 session->rcvbuf_size = *(u32 *) buffer;
3637 VDBG (2, "VPPCOM_ATTR_SET_RX_FIFO_LEN: %u (0x%x), buflen %d,"
3638 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3645 case VPPCOM_ATTR_GET_REUSEADDR:
3646 if (buffer && buflen && (*buflen >= sizeof (int)))
3649 *(int *) buffer = vcl_session_has_attr (session,
3650 VCL_SESS_ATTR_REUSEADDR);
3651 *buflen = sizeof (int);
3653 VDBG (2, "VPPCOM_ATTR_GET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3654 *(int *) buffer, *buflen);
3660 case VPPCOM_ATTR_SET_REUSEADDR:
3661 if (buffer && buflen && (*buflen == sizeof (int)) &&
3662 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3665 if (*(int *) buffer)
3666 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEADDR);
3668 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEADDR);
3670 VDBG (2, "VPPCOM_ATTR_SET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3671 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEADDR),
3678 case VPPCOM_ATTR_GET_REUSEPORT:
3679 if (buffer && buflen && (*buflen >= sizeof (int)))
3682 *(int *) buffer = vcl_session_has_attr (session,
3683 VCL_SESS_ATTR_REUSEPORT);
3684 *buflen = sizeof (int);
3686 VDBG (2, "VPPCOM_ATTR_GET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3687 *(int *) buffer, *buflen);
3693 case VPPCOM_ATTR_SET_REUSEPORT:
3694 if (buffer && buflen && (*buflen == sizeof (int)) &&
3695 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3698 if (*(int *) buffer)
3699 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEPORT);
3701 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEPORT);
3703 VDBG (2, "VPPCOM_ATTR_SET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3704 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEPORT),
3711 case VPPCOM_ATTR_GET_BROADCAST:
3712 if (buffer && buflen && (*buflen >= sizeof (int)))
3715 *(int *) buffer = vcl_session_has_attr (session,
3716 VCL_SESS_ATTR_BROADCAST);
3717 *buflen = sizeof (int);
3719 VDBG (2, "VPPCOM_ATTR_GET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3720 *(int *) buffer, *buflen);
3726 case VPPCOM_ATTR_SET_BROADCAST:
3727 if (buffer && buflen && (*buflen == sizeof (int)))
3730 if (*(int *) buffer)
3731 vcl_session_set_attr (session, VCL_SESS_ATTR_BROADCAST);
3733 vcl_session_clear_attr (session, VCL_SESS_ATTR_BROADCAST);
3735 VDBG (2, "VPPCOM_ATTR_SET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3736 vcl_session_has_attr (session, VCL_SESS_ATTR_BROADCAST),
3743 case VPPCOM_ATTR_GET_V6ONLY:
3744 if (buffer && buflen && (*buflen >= sizeof (int)))
3747 *(int *) buffer = vcl_session_has_attr (session,
3748 VCL_SESS_ATTR_V6ONLY);
3749 *buflen = sizeof (int);
3751 VDBG (2, "VPPCOM_ATTR_GET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3752 *(int *) buffer, *buflen);
3758 case VPPCOM_ATTR_SET_V6ONLY:
3759 if (buffer && buflen && (*buflen == sizeof (int)))
3762 if (*(int *) buffer)
3763 vcl_session_set_attr (session, VCL_SESS_ATTR_V6ONLY);
3765 vcl_session_clear_attr (session, VCL_SESS_ATTR_V6ONLY);
3767 VDBG (2, "VPPCOM_ATTR_SET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3768 vcl_session_has_attr (session, VCL_SESS_ATTR_V6ONLY),
3775 case VPPCOM_ATTR_GET_KEEPALIVE:
3776 if (buffer && buflen && (*buflen >= sizeof (int)))
3779 *(int *) buffer = vcl_session_has_attr (session,
3780 VCL_SESS_ATTR_KEEPALIVE);
3781 *buflen = sizeof (int);
3783 VDBG (2, "VPPCOM_ATTR_GET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3784 *(int *) buffer, *buflen);
3790 case VPPCOM_ATTR_SET_KEEPALIVE:
3791 if (buffer && buflen && (*buflen == sizeof (int)))
3794 if (*(int *) buffer)
3795 vcl_session_set_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3797 vcl_session_clear_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3799 VDBG (2, "VPPCOM_ATTR_SET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3800 vcl_session_has_attr (session, VCL_SESS_ATTR_KEEPALIVE),
3807 case VPPCOM_ATTR_GET_TCP_NODELAY:
3808 if (buffer && buflen && (*buflen >= sizeof (int)))
3811 *(int *) buffer = vcl_session_has_attr (session,
3812 VCL_SESS_ATTR_TCP_NODELAY);
3813 *buflen = sizeof (int);
3815 VDBG (2, "VPPCOM_ATTR_GET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3816 *(int *) buffer, *buflen);
3822 case VPPCOM_ATTR_SET_TCP_NODELAY:
3823 if (buffer && buflen && (*buflen == sizeof (int)))
3826 if (*(int *) buffer)
3827 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3829 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3831 VDBG (2, "VPPCOM_ATTR_SET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3832 vcl_session_has_attr (session, VCL_SESS_ATTR_TCP_NODELAY),
3839 case VPPCOM_ATTR_GET_TCP_KEEPIDLE:
3840 if (buffer && buflen && (*buflen >= sizeof (int)))
3843 *(int *) buffer = vcl_session_has_attr (session,
3844 VCL_SESS_ATTR_TCP_KEEPIDLE);
3845 *buflen = sizeof (int);
3847 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3848 *(int *) buffer, *buflen);
3854 case VPPCOM_ATTR_SET_TCP_KEEPIDLE:
3855 if (buffer && buflen && (*buflen == sizeof (int)))
3858 if (*(int *) buffer)
3859 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3861 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3863 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3864 vcl_session_has_attr (session,
3865 VCL_SESS_ATTR_TCP_KEEPIDLE), *buflen);
3871 case VPPCOM_ATTR_GET_TCP_KEEPINTVL:
3872 if (buffer && buflen && (*buflen >= sizeof (int)))
3875 *(int *) buffer = vcl_session_has_attr (session,
3876 VCL_SESS_ATTR_TCP_KEEPINTVL);
3877 *buflen = sizeof (int);
3879 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3880 *(int *) buffer, *buflen);
3886 case VPPCOM_ATTR_SET_TCP_KEEPINTVL:
3887 if (buffer && buflen && (*buflen == sizeof (int)))
3890 if (*(int *) buffer)
3891 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3893 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3895 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3896 vcl_session_has_attr (session,
3897 VCL_SESS_ATTR_TCP_KEEPINTVL), *buflen);
3903 case VPPCOM_ATTR_GET_TCP_USER_MSS:
3904 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
3910 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3911 tea.mss = *(u32 *) buffer;
3912 if (vcl_session_transport_attr (wrk, session, 1 /* is_get */, &tea))
3913 rv = VPPCOM_ENOPROTOOPT;
3917 *(u32 *) buffer = tea.mss;
3918 *buflen = sizeof (int);
3921 VDBG (2, "VPPCOM_ATTR_GET_TCP_USER_MSS: %d, buflen %d", *(int *) buffer,
3925 case VPPCOM_ATTR_SET_TCP_USER_MSS:
3926 if (!(buffer && buflen && (*buflen == sizeof (u32))))
3932 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3933 tea.mss = *(u32 *) buffer;
3934 if (vcl_session_transport_attr (wrk, session, 0 /* is_get */, &tea))
3935 rv = VPPCOM_ENOPROTOOPT;
3937 VDBG (2, "VPPCOM_ATTR_SET_TCP_USER_MSS: %u, buflen %d", tea.mss,
3941 case VPPCOM_ATTR_SET_CONNECTED:
3942 session->flags |= VCL_SESSION_F_CONNECTED;
3945 case VPPCOM_ATTR_SET_CKPAIR:
3946 if (!(buffer && buflen && (*buflen == sizeof (int))) ||
3947 !vcl_session_has_crypto (session))
3952 if (!session->ext_config)
3954 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_CRYPTO,
3955 sizeof (transport_endpt_ext_cfg_t));
3957 else if (session->ext_config->type != TRANSPORT_ENDPT_EXT_CFG_CRYPTO)
3963 session->ext_config->crypto.ckpair_index = *(uint32_t *) buffer;
3966 case VPPCOM_ATTR_SET_VRF:
3967 if (!(buffer && buflen && (*buflen == sizeof (u32))))
3972 session->vrf = *(u32 *) buffer;
3975 case VPPCOM_ATTR_GET_VRF:
3976 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
3981 *(u32 *) buffer = session->vrf;
3982 *buflen = sizeof (u32);
3985 case VPPCOM_ATTR_GET_DOMAIN:
3986 if (!(buffer && buflen && (*buflen >= sizeof (int))))
3992 if (session->transport.is_ip4)
3993 *(int *) buffer = AF_INET;
3995 *(int *) buffer = AF_INET6;
3996 *buflen = sizeof (int);
3998 VDBG (2, "VPPCOM_ATTR_GET_DOMAIN: %d, buflen %u", *(int *) buffer,
4002 case VPPCOM_ATTR_SET_ENDPT_EXT_CFG:
4003 if (!(buffer && buflen && (*buflen > 0)))
4008 if (session->ext_config)
4013 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_NONE,
4014 *buflen + sizeof (u32));
4015 clib_memcpy (session->ext_config->data, buffer, *buflen);
4016 session->ext_config->len = *buflen;
4028 vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
4029 uint32_t buflen, int flags, vppcom_endpt_t * ep)
4031 vcl_worker_t *wrk = vcl_worker_get_current ();
4032 vcl_session_t *session;
4036 rv = vppcom_session_read (session_handle, buffer, buflen);
4037 else if (flags & MSG_PEEK)
4038 rv = vppcom_session_peek (session_handle, buffer, buflen);
4041 VDBG (0, "Unsupport flags for recvfrom %d", flags);
4042 return VPPCOM_EAFNOSUPPORT;
4047 session = vcl_session_get_w_handle (wrk, session_handle);
4048 if (session->transport.is_ip4)
4049 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
4050 sizeof (ip4_address_t));
4052 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
4053 sizeof (ip6_address_t));
4054 ep->is_ip4 = session->transport.is_ip4;
4055 ep->port = session->transport.rmt_port;
4062 vppcom_session_sendto (uint32_t session_handle, void *buffer,
4063 uint32_t buflen, int flags, vppcom_endpt_t * ep)
4065 vcl_worker_t *wrk = vcl_worker_get_current ();
4068 s = vcl_session_get_w_handle (wrk, session_handle);
4069 if (PREDICT_FALSE (!s))
4070 return VPPCOM_EBADFD;
4074 if (!vcl_session_is_cl (s))
4075 return VPPCOM_EINVAL;
4077 s->transport.is_ip4 = ep->is_ip4;
4078 s->transport.rmt_port = ep->port;
4079 vcl_ip_copy_from_ep (&s->transport.rmt_ip, ep);
4081 /* Session not connected/bound in vpp. Create it by 'connecting' it */
4082 if (PREDICT_FALSE (s->session_state == VCL_STATE_CLOSED))
4084 u32 session_index = s->session_index;
4085 f64 timeout = vcm->cfg.session_timeout;
4088 vcl_send_session_connect (wrk, s);
4089 rv = vppcom_wait_for_session_state_change (session_index,
4094 s = vcl_session_get (wrk, session_index);
4100 // TBD check the flags and do the right thing
4101 VDBG (2, "handling flags 0x%u (%d) not implemented yet.", flags, flags);
4104 return (vppcom_session_write_inline (wrk, s, buffer, buflen, 1,
4105 s->is_dgram ? 1 : 0));
4109 vppcom_poll (vcl_poll_t * vp, uint32_t n_sids, double wait_for_time)
4111 vcl_worker_t *wrk = vcl_worker_get_current ();
4112 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
4113 u32 i, keep_trying = 1;
4114 svm_msg_q_msg_t msg;
4118 VDBG (3, "vp %p, nsids %u, wait_for_time %f", vp, n_sids, wait_for_time);
4121 return VPPCOM_EFAULT;
4125 vcl_session_t *session;
4127 /* Dequeue all events and drop all unhandled io events */
4128 while (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0) == 0)
4130 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
4131 vcl_handle_mq_event (wrk, e);
4132 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
4134 vec_reset_length (wrk->unhandled_evts_vector);
4136 for (i = 0; i < n_sids; i++)
4138 session = vcl_session_get (wrk, vp[i].sh);
4141 vp[i].revents = POLLHUP;
4148 if (POLLIN & vp[i].events)
4150 rv = vcl_session_read_ready (session);
4153 vp[i].revents |= POLLIN;
4160 case VPPCOM_ECONNRESET:
4161 vp[i].revents = POLLHUP;
4165 vp[i].revents = POLLERR;
4172 if (POLLOUT & vp[i].events)
4174 rv = vcl_session_write_ready (session);
4177 vp[i].revents |= POLLOUT;
4184 case VPPCOM_ECONNRESET:
4185 vp[i].revents = POLLHUP;
4189 vp[i].revents = POLLERR;
4196 if (0) // Note "done:" label used by VCL_SESSION_LOCK_AND_GET()
4198 vp[i].revents = POLLNVAL;
4202 if (wait_for_time != -1)
4203 keep_trying = (clib_time_now (&wrk->clib_time) <= timeout) ? 1 : 0;
4205 while ((num_ev == 0) && keep_trying);
4211 vppcom_mq_epoll_fd (void)
4213 vcl_worker_t *wrk = vcl_worker_get_current ();
4214 return wrk->mqs_epfd;
4218 vppcom_session_index (vcl_session_handle_t session_handle)
4220 return session_handle & 0xFFFFFF;
4224 vppcom_session_worker (vcl_session_handle_t session_handle)
4226 return session_handle >> 24;
4230 vppcom_worker_register (void)
4232 if (!vcl_worker_alloc_and_init ())
4233 return VPPCOM_EEXIST;
4235 if (vcl_worker_register_with_vpp ())
4236 return VPPCOM_EEXIST;
4242 vppcom_worker_unregister (void)
4244 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
4245 vcl_set_worker_index (~0);
4249 vppcom_worker_index_set (int index)
4251 vcl_set_worker_index (index);
4255 vppcom_worker_index (void)
4257 return vcl_get_worker_index ();
4261 vppcom_worker_mqs_epfd (void)
4263 vcl_worker_t *wrk = vcl_worker_get_current ();
4264 if (!vcm->cfg.use_mq_eventfd)
4266 return wrk->mqs_epfd;
4270 vppcom_session_is_connectable_listener (uint32_t session_handle)
4272 vcl_session_t *session;
4273 vcl_worker_t *wrk = vcl_worker_get_current ();
4274 session = vcl_session_get_w_handle (wrk, session_handle);
4276 return VPPCOM_EBADFD;
4277 return vcl_session_is_connectable_listener (wrk, session);
4281 vppcom_session_listener (uint32_t session_handle)
4283 vcl_worker_t *wrk = vcl_worker_get_current ();
4284 vcl_session_t *listen_session, *session;
4285 session = vcl_session_get_w_handle (wrk, session_handle);
4287 return VPPCOM_EBADFD;
4288 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
4289 return VPPCOM_EBADFD;
4290 listen_session = vcl_session_get_w_handle (wrk, session->listener_index);
4291 if (!listen_session)
4292 return VPPCOM_EBADFD;
4293 return vcl_session_handle (listen_session);
4297 vppcom_session_n_accepted (uint32_t session_handle)
4299 vcl_worker_t *wrk = vcl_worker_get_current ();
4300 vcl_session_t *session = vcl_session_get_w_handle (wrk, session_handle);
4302 return VPPCOM_EBADFD;
4303 return session->n_accepted_sessions;
4307 vppcom_proto_str (vppcom_proto_t proto)
4309 char const *proto_str;
4313 case VPPCOM_PROTO_TCP:
4316 case VPPCOM_PROTO_UDP:
4319 case VPPCOM_PROTO_TLS:
4322 case VPPCOM_PROTO_QUIC:
4325 case VPPCOM_PROTO_DTLS:
4328 case VPPCOM_PROTO_SRTP:
4332 proto_str = "UNKNOWN";
4339 vppcom_retval_str (int retval)
4350 st = "VPPCOM_EAGAIN";
4354 st = "VPPCOM_EFAULT";
4358 st = "VPPCOM_ENOMEM";
4362 st = "VPPCOM_EINVAL";
4366 st = "VPPCOM_EBADFD";
4369 case VPPCOM_EAFNOSUPPORT:
4370 st = "VPPCOM_EAFNOSUPPORT";
4373 case VPPCOM_ECONNABORTED:
4374 st = "VPPCOM_ECONNABORTED";
4377 case VPPCOM_ECONNRESET:
4378 st = "VPPCOM_ECONNRESET";
4381 case VPPCOM_ENOTCONN:
4382 st = "VPPCOM_ENOTCONN";
4385 case VPPCOM_ECONNREFUSED:
4386 st = "VPPCOM_ECONNREFUSED";
4389 case VPPCOM_ETIMEDOUT:
4390 st = "VPPCOM_ETIMEDOUT";
4394 st = "UNKNOWN_STATE";
4402 vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
4404 if (vcm->cfg.vpp_app_socket_api)
4405 return vcl_sapi_add_cert_key_pair (ckpair);
4407 return vcl_bapi_add_cert_key_pair (ckpair);
4411 vppcom_del_cert_key_pair (uint32_t ckpair_index)
4413 if (vcm->cfg.vpp_app_socket_api)
4414 return vcl_sapi_del_cert_key_pair (ckpair_index);
4416 return vcl_bapi_del_cert_key_pair (ckpair_index);
4420 * fd.io coding-style-patch-verification: ON
4423 * eval: (c-set-style "gnu")