2 * Copyright (c) 2017-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 #include <vcl/vppcom.h>
19 #include <vcl/vcl_debug.h>
20 #include <vcl/vcl_private.h>
21 #include <svm/fifo_segment.h>
23 __thread uword __vcl_worker_index = ~0;
26 vcl_mq_dequeue_batch (vcl_worker_t * wrk, svm_msg_q_t * mq, u32 n_max_msg)
28 u32 n_msgs = 0, sz, len;
30 while ((sz = svm_msg_q_size (mq)))
32 len = vec_len (wrk->mq_msg_vector);
33 vec_validate (wrk->mq_msg_vector, len + sz - 1);
34 svm_msg_q_sub_raw_batch (mq, wrk->mq_msg_vector + len, sz);
43 vcl_msg_add_ext_config (vcl_session_t *s, uword *offset)
47 c = vcl_segment_alloc_chunk (vcl_vpp_worker_segment_handle (0),
48 0 /* one slice only */, s->ext_config->len,
51 clib_memcpy_fast (c->data, s->ext_config, s->ext_config->len);
55 vcl_send_session_listen (vcl_worker_t * wrk, vcl_session_t * s)
57 app_session_evt_t _app_evt, *app_evt = &_app_evt;
58 session_listen_msg_t *mp;
61 mq = vcl_worker_ctrl_mq (wrk);
62 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_LISTEN);
63 mp = (session_listen_msg_t *) app_evt->evt->data;
64 memset (mp, 0, sizeof (*mp));
65 mp->client_index = wrk->api_client_handle;
66 mp->context = s->session_index;
67 mp->wrk_index = wrk->vpp_wrk_index;
68 mp->is_ip4 = s->transport.is_ip4;
69 clib_memcpy_fast (&mp->ip, &s->transport.lcl_ip, sizeof (mp->ip));
70 mp->port = s->transport.lcl_port;
71 mp->proto = s->session_type;
73 if (s->flags & VCL_SESSION_F_CONNECTED)
74 mp->flags = TRANSPORT_CFG_F_CONNECTED;
76 vcl_msg_add_ext_config (s, &mp->ext_config);
77 app_send_ctrl_evt_to_vpp (mq, app_evt);
80 clib_mem_free (s->ext_config);
86 vcl_send_session_connect (vcl_worker_t * wrk, vcl_session_t * s)
88 app_session_evt_t _app_evt, *app_evt = &_app_evt;
89 session_connect_msg_t *mp;
92 mq = vcl_worker_ctrl_mq (wrk);
93 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_CONNECT);
94 mp = (session_connect_msg_t *) app_evt->evt->data;
95 memset (mp, 0, sizeof (*mp));
96 mp->client_index = wrk->api_client_handle;
97 mp->context = s->session_index;
99 mp->wrk_index = wrk->vpp_wrk_index;
100 mp->is_ip4 = s->transport.is_ip4;
101 mp->parent_handle = s->parent_handle;
102 clib_memcpy_fast (&mp->ip, &s->transport.rmt_ip, sizeof (mp->ip));
103 clib_memcpy_fast (&mp->lcl_ip, &s->transport.lcl_ip, sizeof (mp->lcl_ip));
104 mp->port = s->transport.rmt_port;
105 mp->lcl_port = s->transport.lcl_port;
106 mp->proto = s->session_type;
108 if (s->flags & VCL_SESSION_F_CONNECTED)
109 mp->flags |= TRANSPORT_CFG_F_CONNECTED;
111 vcl_msg_add_ext_config (s, &mp->ext_config);
112 app_send_ctrl_evt_to_vpp (mq, app_evt);
116 clib_mem_free (s->ext_config);
122 vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s)
124 app_session_evt_t _app_evt, *app_evt = &_app_evt;
125 session_unlisten_msg_t *mp;
128 mq = vcl_worker_ctrl_mq (wrk);
129 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_UNLISTEN);
130 mp = (session_unlisten_msg_t *) app_evt->evt->data;
131 memset (mp, 0, sizeof (*mp));
132 mp->client_index = wrk->api_client_handle;
133 mp->wrk_index = wrk->vpp_wrk_index;
134 mp->handle = s->vpp_handle;
135 mp->context = wrk->wrk_index;
136 app_send_ctrl_evt_to_vpp (mq, app_evt);
140 vcl_send_session_shutdown (vcl_worker_t *wrk, vcl_session_t *s)
142 app_session_evt_t _app_evt, *app_evt = &_app_evt;
143 session_shutdown_msg_t *mp;
146 /* Send to thread that owns the session */
148 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_SHUTDOWN);
149 mp = (session_shutdown_msg_t *) app_evt->evt->data;
150 memset (mp, 0, sizeof (*mp));
151 mp->client_index = wrk->api_client_handle;
152 mp->handle = s->vpp_handle;
153 app_send_ctrl_evt_to_vpp (mq, app_evt);
157 vcl_send_session_disconnect (vcl_worker_t * wrk, vcl_session_t * s)
159 app_session_evt_t _app_evt, *app_evt = &_app_evt;
160 session_disconnect_msg_t *mp;
163 /* Send to thread that owns the session */
165 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_DISCONNECT);
166 mp = (session_disconnect_msg_t *) app_evt->evt->data;
167 memset (mp, 0, sizeof (*mp));
168 mp->client_index = wrk->api_client_handle;
169 mp->handle = s->vpp_handle;
170 app_send_ctrl_evt_to_vpp (mq, app_evt);
174 vcl_send_app_detach (vcl_worker_t * wrk)
176 app_session_evt_t _app_evt, *app_evt = &_app_evt;
177 session_app_detach_msg_t *mp;
180 mq = vcl_worker_ctrl_mq (wrk);
181 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_DETACH);
182 mp = (session_app_detach_msg_t *) app_evt->evt->data;
183 memset (mp, 0, sizeof (*mp));
184 mp->client_index = wrk->api_client_handle;
185 app_send_ctrl_evt_to_vpp (mq, app_evt);
189 vcl_send_session_accepted_reply (svm_msg_q_t * mq, u32 context,
190 session_handle_t handle, int retval)
192 app_session_evt_t _app_evt, *app_evt = &_app_evt;
193 session_accepted_reply_msg_t *rmp;
194 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_ACCEPTED_REPLY);
195 rmp = (session_accepted_reply_msg_t *) app_evt->evt->data;
196 rmp->handle = handle;
197 rmp->context = context;
198 rmp->retval = retval;
199 app_send_ctrl_evt_to_vpp (mq, app_evt);
203 vcl_send_session_disconnected_reply (vcl_worker_t * wrk, vcl_session_t * s,
206 app_session_evt_t _app_evt, *app_evt = &_app_evt;
207 session_disconnected_reply_msg_t *rmp;
208 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
209 SESSION_CTRL_EVT_DISCONNECTED_REPLY);
210 rmp = (session_disconnected_reply_msg_t *) app_evt->evt->data;
211 rmp->handle = s->vpp_handle;
212 rmp->context = wrk->api_client_handle;
213 rmp->retval = retval;
214 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
218 vcl_send_session_reset_reply (vcl_worker_t * wrk, vcl_session_t * s,
221 app_session_evt_t _app_evt, *app_evt = &_app_evt;
222 session_reset_reply_msg_t *rmp;
223 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
224 SESSION_CTRL_EVT_RESET_REPLY);
225 rmp = (session_reset_reply_msg_t *) app_evt->evt->data;
226 rmp->handle = s->vpp_handle;
227 rmp->context = wrk->api_client_handle;
228 rmp->retval = retval;
229 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
233 vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
236 app_session_evt_t _app_evt, *app_evt = &_app_evt;
237 session_worker_update_msg_t *mp;
239 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
240 SESSION_CTRL_EVT_WORKER_UPDATE);
241 mp = (session_worker_update_msg_t *) app_evt->evt->data;
242 mp->client_index = wrk->api_client_handle;
243 mp->handle = s->vpp_handle;
244 mp->req_wrk_index = wrk->vpp_wrk_index;
245 mp->wrk_index = wrk_index;
246 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
250 vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len)
252 app_session_evt_t _app_evt, *app_evt = &_app_evt;
253 session_app_wrk_rpc_msg_t *mp;
254 vcl_worker_t *dst_wrk, *wrk;
258 if (data_len > sizeof (mp->data))
261 clib_spinlock_lock (&vcm->workers_lock);
263 dst_wrk = vcl_worker_get_if_valid (dst_wrk_index);
267 wrk = vcl_worker_get_current ();
268 mq = vcl_worker_ctrl_mq (wrk);
269 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_WRK_RPC);
270 mp = (session_app_wrk_rpc_msg_t *) app_evt->evt->data;
271 mp->client_index = wrk->api_client_handle;
272 mp->wrk_index = dst_wrk->vpp_wrk_index;
273 clib_memcpy (mp->data, data, data_len);
274 app_send_ctrl_evt_to_vpp (mq, app_evt);
278 clib_spinlock_unlock (&vcm->workers_lock);
283 vcl_session_transport_attr (vcl_worker_t *wrk, vcl_session_t *s, u8 is_get,
284 transport_endpt_attr_t *attr)
286 app_session_evt_t _app_evt, *app_evt = &_app_evt;
287 session_transport_attr_msg_t *mp;
291 ASSERT (!wrk->session_attr_op);
293 if (PREDICT_FALSE (!mq))
295 /* FIXME: attribute should be stored and sent once session is
296 * bound/connected to vpp */
300 wrk->session_attr_op = 1;
301 wrk->session_attr_op_rv = -1;
303 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_TRANSPORT_ATTR);
304 mp = (session_transport_attr_msg_t *) app_evt->evt->data;
305 memset (mp, 0, sizeof (*mp));
306 mp->client_index = wrk->api_client_handle;
307 mp->handle = s->vpp_handle;
310 app_send_ctrl_evt_to_vpp (mq, app_evt);
312 timeout = clib_time_now (&wrk->clib_time) + 1;
314 while (wrk->session_attr_op && clib_time_now (&wrk->clib_time) < timeout)
315 vcl_flush_mq_events ();
317 if (!wrk->session_attr_op_rv && is_get)
318 *attr = wrk->session_attr_rv;
320 wrk->session_attr_op = 0;
322 return wrk->session_attr_op_rv;
326 vcl_session_accepted_handler (vcl_worker_t * wrk, session_accepted_msg_t * mp,
329 vcl_session_t *session, *listen_session;
332 session = vcl_session_alloc (wrk);
334 listen_session = vcl_session_get (wrk, ls_index);
335 if (listen_session->vpp_handle != mp->listener_handle)
337 VDBG (0, "ERROR: listener handle %lu does not match session %u",
338 mp->listener_handle, ls_index);
342 if (vcl_segment_attach_session (
343 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
344 mp->vpp_event_queue_address, mp->mq_index, 0, session))
346 VDBG (0, "session %u [0x%llx]: failed to attach fifos",
347 session->session_index, mp->handle);
351 session->vpp_handle = mp->handle;
352 session->session_state = VCL_STATE_READY;
353 session->transport.rmt_port = mp->rmt.port;
354 session->transport.is_ip4 = mp->rmt.is_ip4;
355 clib_memcpy_fast (&session->transport.rmt_ip, &mp->rmt.ip,
356 sizeof (ip46_address_t));
358 vcl_session_table_add_vpp_handle (wrk, mp->handle, session->session_index);
359 session->transport.lcl_port = mp->lcl.port;
360 session->transport.lcl_ip = mp->lcl.ip;
361 session->session_type = listen_session->session_type;
362 session->is_dgram = vcl_proto_is_dgram (session->session_type);
363 session->listener_index = listen_session->session_index;
364 listen_session->n_accepted_sessions++;
366 vcl_evt (VCL_EVT_ACCEPT, session, listen_session, session_index);
368 vcl_send_session_accepted_reply (session->vpp_evt_q, mp->context,
369 session->vpp_handle, 0);
371 return session->session_index;
374 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0),
375 mp->vpp_event_queue_address, mp->mq_index, &evt_q);
376 vcl_send_session_accepted_reply (evt_q, mp->context, mp->handle,
377 VNET_API_ERROR_INVALID_ARGUMENT);
378 vcl_session_free (wrk, session);
379 return VCL_INVALID_SESSION_INDEX;
383 vcl_session_connected_handler (vcl_worker_t * wrk,
384 session_connected_msg_t * mp)
386 vcl_session_t *session = 0;
389 session_index = mp->context;
390 session = vcl_session_get (wrk, session_index);
391 if (PREDICT_FALSE (!session))
393 VERR ("vpp handle 0x%llx has no session index (%u)!", mp->handle,
395 /* Should not happen but if it does, force vpp session cleanup */
396 vcl_session_t tmp_session = {
397 .vpp_handle = mp->handle,
400 vcl_segment_attach_session (
401 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
402 mp->vpp_event_queue_address, mp->mq_index, 0, session);
403 if (tmp_session.vpp_evt_q)
404 vcl_send_session_disconnect (wrk, &tmp_session);
405 return VCL_INVALID_SESSION_INDEX;
410 VDBG (0, "session %u: connect failed! %U", session_index,
411 format_session_error, mp->retval);
412 session->session_state = VCL_STATE_DETACHED;
413 session->vpp_handle = VCL_INVALID_SESSION_HANDLE;
414 session->vpp_error = mp->retval;
415 return session_index;
418 session->vpp_handle = mp->handle;
420 /* Add to lookup table. Even if something fails, session cannot be
421 * cleaned up prior to notifying vpp and going through the cleanup
422 * "procedure" see @ref vcl_session_cleanup_handler */
423 vcl_session_table_add_vpp_handle (wrk, mp->handle, session_index);
425 if (vcl_segment_attach_session (
426 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
427 mp->vpp_event_queue_address, mp->mq_index, 0, session))
429 VDBG (0, "session %u [0x%llx]: failed to attach fifos",
430 session->session_index, session->vpp_handle);
431 session->session_state = VCL_STATE_UPDATED;
432 vcl_send_session_disconnect (wrk, session);
433 return session_index;
438 if (vcl_segment_attach_session (mp->ct_segment_handle, mp->ct_rx_fifo,
439 mp->ct_tx_fifo, (uword) ~0, ~0, 1,
442 VDBG (0, "session %u [0x%llx]: failed to attach ct fifos",
443 session->session_index, session->vpp_handle);
444 session->session_state = VCL_STATE_UPDATED;
445 vcl_send_session_disconnect (wrk, session);
446 return session_index;
450 session->transport.is_ip4 = mp->lcl.is_ip4;
451 clib_memcpy_fast (&session->transport.lcl_ip, &mp->lcl.ip,
452 sizeof (session->transport.lcl_ip));
453 session->transport.lcl_port = mp->lcl.port;
455 /* Application closed session before connect reply */
456 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK)
457 && session->session_state == VCL_STATE_CLOSED)
458 vcl_send_session_disconnect (wrk, session);
460 session->session_state = VCL_STATE_READY;
462 VDBG (0, "session %u [0x%llx] connected local: %U:%u remote %U:%u",
463 session->session_index, session->vpp_handle, vcl_format_ip46_address,
464 &session->transport.lcl_ip,
465 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
466 clib_net_to_host_u16 (session->transport.lcl_port),
467 vcl_format_ip46_address, &session->transport.rmt_ip,
468 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
469 clib_net_to_host_u16 (session->transport.rmt_port));
471 return session_index;
475 vcl_flag_accepted_session (vcl_session_t * session, u64 handle, u32 flags)
477 vcl_session_msg_t *accepted_msg;
480 for (i = 0; i < vec_len (session->accept_evts_fifo); i++)
482 accepted_msg = &session->accept_evts_fifo[i];
483 if (accepted_msg->accepted_msg.handle == handle)
485 accepted_msg->flags |= flags;
493 vcl_session_reset_handler (vcl_worker_t * wrk,
494 session_reset_msg_t * reset_msg)
496 vcl_session_t *session;
499 sid = vcl_session_index_from_vpp_handle (wrk, reset_msg->handle);
500 session = vcl_session_get (wrk, sid);
503 VDBG (0, "request to reset unknown handle 0x%llx", reset_msg->handle);
504 return VCL_INVALID_SESSION_INDEX;
507 /* Caught a reset before actually accepting the session */
508 if (session->session_state == VCL_STATE_LISTEN)
511 if (!vcl_flag_accepted_session (session, reset_msg->handle,
512 VCL_ACCEPTED_F_RESET))
513 VDBG (0, "session was not accepted!");
514 return VCL_INVALID_SESSION_INDEX;
517 if (session->session_state != VCL_STATE_CLOSED)
518 session->session_state = VCL_STATE_DISCONNECT;
520 session->flags |= (VCL_SESSION_F_RD_SHUTDOWN | VCL_SESSION_F_WR_SHUTDOWN);
521 VDBG (0, "session %u [0x%llx]: reset", sid, reset_msg->handle);
526 vcl_session_bound_handler (vcl_worker_t * wrk, session_bound_msg_t * mp)
528 vcl_session_t *session;
529 u32 sid = mp->context;
531 session = vcl_session_get (wrk, sid);
534 VERR ("session %u [0x%llx]: bind failed: %U", sid, mp->handle,
535 format_session_error, mp->retval);
538 session->session_state = VCL_STATE_DETACHED;
539 session->vpp_handle = mp->handle;
544 VDBG (0, "session %u [0x%llx]: Invalid session index!", sid,
546 return VCL_INVALID_SESSION_INDEX;
550 session->vpp_handle = mp->handle;
551 session->transport.is_ip4 = mp->lcl_is_ip4;
552 clib_memcpy_fast (&session->transport.lcl_ip, mp->lcl_ip,
553 sizeof (ip46_address_t));
554 session->transport.lcl_port = mp->lcl_port;
555 vcl_session_table_add_listener (wrk, mp->handle, sid);
556 session->session_state = VCL_STATE_LISTEN;
558 if (vcl_session_is_cl (session))
560 if (vcl_segment_attach_session (mp->segment_handle, mp->rx_fifo,
561 mp->tx_fifo, mp->vpp_evt_q, mp->mq_index,
564 VDBG (0, "session %u [0x%llx]: failed to attach fifos",
565 session->session_index, session->vpp_handle);
566 session->session_state = VCL_STATE_DETACHED;
567 return VCL_INVALID_SESSION_INDEX;
571 VDBG (0, "session %u [0x%llx]: listen succeeded!", sid, mp->handle);
576 vcl_session_unlisten_reply_handler (vcl_worker_t * wrk, void *data)
578 session_unlisten_reply_msg_t *mp = (session_unlisten_reply_msg_t *) data;
581 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
584 VDBG (0, "Unlisten reply with wrong handle %llx", mp->handle);
587 if (s->session_state != VCL_STATE_DISCONNECT)
589 /* Connected udp listener */
590 if (s->session_type == VPPCOM_PROTO_UDP
591 && s->session_state == VCL_STATE_CLOSED)
594 VDBG (0, "Unlisten session in wrong state %llx", mp->handle);
599 VDBG (0, "ERROR: session %u [0xllx]: unlisten failed: %U",
600 s->session_index, mp->handle, format_session_error, mp->retval);
602 if (mp->context != wrk->wrk_index)
603 VDBG (0, "wrong context");
605 vcl_session_table_del_vpp_handle (wrk, mp->handle);
606 vcl_session_free (wrk, s);
610 vcl_session_migrated_handler (vcl_worker_t * wrk, void *data)
612 session_migrated_msg_t *mp = (session_migrated_msg_t *) data;
616 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
619 VDBG (0, "Migrated notification with wrong handle %llx", mp->handle);
623 /* Only validate if a value is provided */
624 if (mp->segment_handle != SESSION_INVALID_HANDLE)
626 fs_index = vcl_segment_table_lookup (mp->segment_handle);
627 if (fs_index == VCL_INVALID_SEGMENT_INDEX)
629 VDBG (0, "segment %lx for session %u is not mounted!",
630 mp->segment_handle, s->session_index);
631 s->session_state = VCL_STATE_DETACHED;
636 s->vpp_handle = mp->new_handle;
638 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0), mp->vpp_evt_q,
639 mp->vpp_thread_index, &s->vpp_evt_q);
641 vcl_session_table_del_vpp_handle (wrk, mp->handle);
642 vcl_session_table_add_vpp_handle (wrk, mp->new_handle, s->session_index);
644 /* Generate new tx event if we have outstanding data */
645 if (svm_fifo_has_event (s->tx_fifo))
646 app_send_io_evt_to_vpp (s->vpp_evt_q,
647 s->tx_fifo->shr->master_session_index,
648 SESSION_IO_EVT_TX, SVM_Q_WAIT);
650 VDBG (0, "Migrated 0x%lx to thread %u 0x%lx", mp->handle,
651 mp->vpp_thread_index, mp->new_handle);
654 static vcl_session_t *
655 vcl_session_accepted (vcl_worker_t * wrk, session_accepted_msg_t * msg)
657 vcl_session_msg_t *vcl_msg;
658 vcl_session_t *session;
660 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
661 if (PREDICT_FALSE (session != 0))
662 VWRN ("session overlap handle %lu state %u!", msg->handle,
663 session->session_state);
665 session = vcl_session_table_lookup_listener (wrk, msg->listener_handle);
668 VERR ("couldn't find listen session: listener handle %llx",
669 msg->listener_handle);
673 clib_fifo_add2 (session->accept_evts_fifo, vcl_msg);
675 vcl_msg->accepted_msg = *msg;
676 /* Session handle points to listener until fully accepted by app */
677 vcl_session_table_add_vpp_handle (wrk, msg->handle, session->session_index);
682 static vcl_session_t *
683 vcl_session_disconnected_handler (vcl_worker_t * wrk,
684 session_disconnected_msg_t * msg)
686 vcl_session_t *session;
688 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
691 VWRN ("request to disconnect unknown handle 0x%llx", msg->handle);
695 /* Late disconnect notification on a session that has been closed */
696 if (session->session_state == VCL_STATE_CLOSED)
699 /* Caught a disconnect before actually accepting the session */
700 if (session->session_state == VCL_STATE_LISTEN)
702 if (!vcl_flag_accepted_session (session, msg->handle,
703 VCL_ACCEPTED_F_CLOSED))
704 VDBG (0, "session was not accepted!");
708 /* If not already reset change state */
709 if (session->session_state != VCL_STATE_DISCONNECT)
710 session->session_state = VCL_STATE_VPP_CLOSING;
716 vppcom_session_shutdown (uint32_t session_handle, int how)
718 vcl_worker_t *wrk = vcl_worker_get_current ();
719 vcl_session_t *session;
720 vcl_session_state_t state;
723 session = vcl_session_get_w_handle (wrk, session_handle);
724 if (PREDICT_FALSE (!session))
725 return VPPCOM_EBADFD;
727 vpp_handle = session->vpp_handle;
728 state = session->session_state;
730 VDBG (1, "session %u [0x%llx] state 0x%x (%s)", session->session_index,
731 vpp_handle, state, vcl_session_state_str (state));
733 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
735 VDBG (0, "ERROR: Cannot shutdown a listen socket!");
736 return VPPCOM_EBADFD;
739 if (how == SHUT_RD || how == SHUT_RDWR)
741 session->flags |= VCL_SESSION_F_RD_SHUTDOWN;
745 session->flags |= VCL_SESSION_F_WR_SHUTDOWN;
747 if (PREDICT_TRUE (state == VCL_STATE_READY))
749 VDBG (1, "session %u [0x%llx]: sending shutdown...",
750 session->session_index, vpp_handle);
752 vcl_send_session_shutdown (wrk, session);
759 vppcom_session_disconnect (u32 session_handle)
761 vcl_worker_t *wrk = vcl_worker_get_current ();
762 vcl_session_t *session, *listen_session;
763 vcl_session_state_t state;
766 session = vcl_session_get_w_handle (wrk, session_handle);
768 return VPPCOM_EBADFD;
770 vpp_handle = session->vpp_handle;
771 state = session->session_state;
773 VDBG (1, "session %u [0x%llx]: disconnecting state (%s)",
774 session->session_index, vpp_handle, vcl_session_state_str (state));
776 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
778 VDBG (0, "ERROR: Cannot disconnect a listen socket!");
779 return VPPCOM_EBADFD;
782 if (state == VCL_STATE_VPP_CLOSING)
784 vcl_send_session_disconnected_reply (wrk, session, 0);
785 VDBG (1, "session %u [0x%llx]: sending disconnect REPLY...",
786 session->session_index, vpp_handle);
790 /* Session doesn't have an event queue yet. Probably a non-blocking
791 * connect. Wait for the reply */
792 if (PREDICT_FALSE (!session->vpp_evt_q))
795 VDBG (1, "session %u [0x%llx]: sending disconnect",
796 session->session_index, vpp_handle);
797 vcl_send_session_disconnect (wrk, session);
800 if (session->listener_index != VCL_INVALID_SESSION_INDEX)
802 listen_session = vcl_session_get (wrk, session->listener_index);
804 listen_session->n_accepted_sessions--;
811 vcl_session_cleanup_handler (vcl_worker_t * wrk, void *data)
813 session_cleanup_msg_t *msg;
814 vcl_session_t *session;
816 msg = (session_cleanup_msg_t *) data;
817 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
820 VWRN ("disconnect confirmed for unknown handle 0x%llx", msg->handle);
824 if (msg->type == SESSION_CLEANUP_TRANSPORT)
826 /* Transport was cleaned up before we confirmed close. Probably the
827 * app is still waiting for some data that cannot be delivered.
828 * Confirm close to make sure everything is cleaned up.
829 * Move to undetermined state to ensure that the session is not
830 * removed before both vpp and the app cleanup.
831 * - If the app closes first, the session is moved to CLOSED state
832 * and the session cleanup notification from vpp removes the
834 * - If vpp cleans up the session first, the session is moved to
835 * DETACHED state lower and subsequently the close from the app
838 if (session->session_state == VCL_STATE_VPP_CLOSING)
840 vppcom_session_disconnect (vcl_session_handle (session));
841 session->session_state = VCL_STATE_UPDATED;
843 else if (session->session_state == VCL_STATE_DISCONNECT)
845 vcl_send_session_reset_reply (wrk, session, 0);
846 session->session_state = VCL_STATE_UPDATED;
851 /* VPP will reuse the handle so clean it up now */
852 vcl_session_table_del_vpp_handle (wrk, msg->handle);
854 /* App did not close the connection yet so don't free it. */
855 if (session->session_state != VCL_STATE_CLOSED)
857 VDBG (0, "session %u: app did not close", session->session_index);
858 session->session_state = VCL_STATE_DETACHED;
859 session->vpp_handle = VCL_INVALID_SESSION_HANDLE;
863 /* Session probably tracked with epoll, disconnect not yet handled and
864 * 1) both transport and session cleanup completed 2) app closed. Wait
865 * until message is drained to free the session.
866 * See @ref vcl_handle_mq_event */
867 if (session->flags & VCL_SESSION_F_PENDING_DISCONNECT)
869 session->flags |= VCL_SESSION_F_PENDING_FREE;
873 vcl_session_free (wrk, session);
877 vcl_session_req_worker_update_handler (vcl_worker_t * wrk, void *data)
879 session_req_worker_update_msg_t *msg;
882 msg = (session_req_worker_update_msg_t *) data;
883 s = vcl_session_get_w_vpp_handle (wrk, msg->session_handle);
887 vec_add1 (wrk->pending_session_wrk_updates, s->session_index);
891 vcl_session_worker_update_reply_handler (vcl_worker_t * wrk, void *data)
893 session_worker_update_reply_msg_t *msg;
896 msg = (session_worker_update_reply_msg_t *) data;
897 s = vcl_session_get_w_vpp_handle (wrk, msg->handle);
900 VDBG (0, "unknown handle 0x%llx", msg->handle);
906 if (vcl_segment_attach_session (msg->segment_handle, msg->rx_fifo,
907 msg->tx_fifo, (uword) ~0, ~0, 0, s))
909 VDBG (0, "failed to attach fifos for %u", s->session_index);
913 s->session_state = VCL_STATE_UPDATED;
915 VDBG (0, "session %u[0x%llx] moved to worker %u", s->session_index,
916 s->vpp_handle, wrk->wrk_index);
920 vcl_api_recv_fd (vcl_worker_t * wrk, int *fds, int n_fds)
923 if (vcm->cfg.vpp_app_socket_api)
924 return vcl_sapi_recv_fds (wrk, fds, n_fds);
926 return vcl_bapi_recv_fds (wrk, fds, n_fds);
930 vcl_session_app_add_segment_handler (vcl_worker_t * wrk, void *data)
932 ssvm_segment_type_t seg_type = SSVM_SEGMENT_SHM;
933 session_app_add_segment_msg_t *msg;
937 msg = (session_app_add_segment_msg_t *) data;
941 vcl_api_recv_fd (wrk, &fd, 1);
942 seg_type = SSVM_SEGMENT_MEMFD;
945 segment_handle = msg->segment_handle;
946 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
948 clib_warning ("invalid segment handle");
952 if (vcl_segment_attach (segment_handle, (char *) msg->segment_name,
955 VDBG (0, "vcl_segment_attach ('%s') failed", msg->segment_name);
959 VDBG (1, "mapped new segment '%s' size %d", msg->segment_name,
964 vcl_session_app_del_segment_handler (vcl_worker_t * wrk, void *data)
966 session_app_del_segment_msg_t *msg = (session_app_del_segment_msg_t *) data;
967 vcl_segment_detach (msg->segment_handle);
968 VDBG (1, "Unmapped segment: %d", msg->segment_handle);
972 vcl_worker_rpc_handler (vcl_worker_t * wrk, void *data)
974 if (!vcm->wrk_rpc_fn)
977 (vcm->wrk_rpc_fn) (((session_app_wrk_rpc_msg_t *) data)->data);
981 vcl_session_transport_attr_reply_handler (vcl_worker_t *wrk, void *data)
983 session_transport_attr_reply_msg_t *mp;
985 if (!wrk->session_attr_op)
988 mp = (session_transport_attr_reply_msg_t *) data;
990 wrk->session_attr_op_rv = mp->retval;
991 wrk->session_attr_op = 0;
992 wrk->session_attr_rv = mp->attr;
996 vcl_handle_mq_event (vcl_worker_t * wrk, session_event_t * e)
998 session_disconnected_msg_t *disconnected_msg;
999 session_connected_msg_t *connected_msg;
1000 session_reset_msg_t *reset_msg;
1001 session_event_t *ecpy;
1005 switch (e->event_type)
1007 case SESSION_IO_EVT_RX:
1008 case SESSION_IO_EVT_TX:
1009 s = vcl_session_get (wrk, e->session_index);
1010 if (!s || !vcl_session_is_open (s))
1012 vec_add1 (wrk->unhandled_evts_vector, *e);
1014 case SESSION_CTRL_EVT_BOUND:
1015 /* We can only wait for only one listen so not postponed */
1016 vcl_session_bound_handler (wrk, (session_bound_msg_t *) e->data);
1018 case SESSION_CTRL_EVT_ACCEPTED:
1019 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
1020 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1022 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1024 ecpy->postponed = 1;
1025 ecpy->session_index = s->session_index;
1028 case SESSION_CTRL_EVT_CONNECTED:
1029 connected_msg = (session_connected_msg_t *) e->data;
1030 sid = vcl_session_connected_handler (wrk, connected_msg);
1031 if (!(s = vcl_session_get (wrk, sid)))
1033 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1035 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1037 ecpy->postponed = 1;
1038 ecpy->session_index = s->session_index;
1041 case SESSION_CTRL_EVT_DISCONNECTED:
1042 disconnected_msg = (session_disconnected_msg_t *) e->data;
1043 if (!(s = vcl_session_get_w_vpp_handle (wrk, disconnected_msg->handle)))
1045 if (s->session_state == VCL_STATE_CLOSED)
1047 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1049 s->session_state = VCL_STATE_VPP_CLOSING;
1050 s->flags |= VCL_SESSION_F_PENDING_DISCONNECT;
1051 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1053 ecpy->postponed = 1;
1054 ecpy->session_index = s->session_index;
1057 if (!(s = vcl_session_disconnected_handler (wrk, disconnected_msg)))
1059 VDBG (0, "disconnected session %u [0x%llx]", s->session_index,
1062 case SESSION_CTRL_EVT_RESET:
1063 reset_msg = (session_reset_msg_t *) e->data;
1064 if (!(s = vcl_session_get_w_vpp_handle (wrk, reset_msg->handle)))
1066 if (s->session_state == VCL_STATE_CLOSED)
1068 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1070 s->flags |= VCL_SESSION_F_PENDING_DISCONNECT;
1071 s->session_state = VCL_STATE_DISCONNECT;
1072 s->flags |= (VCL_SESSION_F_RD_SHUTDOWN | VCL_SESSION_F_WR_SHUTDOWN);
1073 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1075 ecpy->postponed = 1;
1076 ecpy->session_index = s->session_index;
1079 vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
1081 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
1082 vcl_session_unlisten_reply_handler (wrk, e->data);
1084 case SESSION_CTRL_EVT_MIGRATED:
1085 vcl_session_migrated_handler (wrk, e->data);
1087 case SESSION_CTRL_EVT_CLEANUP:
1088 vcl_session_cleanup_handler (wrk, e->data);
1090 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
1091 vcl_session_req_worker_update_handler (wrk, e->data);
1093 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
1094 vcl_session_worker_update_reply_handler (wrk, e->data);
1096 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
1097 vcl_session_app_add_segment_handler (wrk, e->data);
1099 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
1100 vcl_session_app_del_segment_handler (wrk, e->data);
1102 case SESSION_CTRL_EVT_APP_WRK_RPC:
1103 vcl_worker_rpc_handler (wrk, e->data);
1105 case SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY:
1106 vcl_session_transport_attr_reply_handler (wrk, e->data);
1109 clib_warning ("unhandled %u", e->event_type);
1115 vppcom_wait_for_session_state_change (u32 session_index,
1116 vcl_session_state_t state,
1119 vcl_worker_t *wrk = vcl_worker_get_current ();
1120 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
1121 vcl_session_t *volatile session;
1122 svm_msg_q_msg_t msg;
1127 session = vcl_session_get (wrk, session_index);
1128 if (PREDICT_FALSE (!session))
1130 return VPPCOM_EBADFD;
1132 if (session->session_state == state)
1136 if (session->session_state == VCL_STATE_DETACHED)
1138 return VPPCOM_ECONNREFUSED;
1141 if (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0))
1146 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
1147 vcl_handle_mq_event (wrk, e);
1148 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
1150 while (clib_time_now (&wrk->clib_time) < timeout);
1152 VDBG (0, "timeout waiting for state 0x%x (%s)", state,
1153 vcl_session_state_str (state));
1154 vcl_evt (VCL_EVT_SESSION_TIMEOUT, session, session_state);
1156 return VPPCOM_ETIMEDOUT;
1160 vcl_handle_pending_wrk_updates (vcl_worker_t * wrk)
1162 vcl_session_state_t state;
1166 if (PREDICT_TRUE (vec_len (wrk->pending_session_wrk_updates) == 0))
1169 vec_foreach (sip, wrk->pending_session_wrk_updates)
1171 s = vcl_session_get (wrk, *sip);
1172 vcl_send_session_worker_update (wrk, s, wrk->wrk_index);
1173 state = s->session_state;
1174 vppcom_wait_for_session_state_change (s->session_index, VCL_STATE_UPDATED,
1176 s->session_state = state;
1178 vec_reset_length (wrk->pending_session_wrk_updates);
1182 vcl_worker_flush_mq_events (vcl_worker_t *wrk)
1184 svm_msg_q_msg_t *msg;
1189 mq = wrk->app_event_queue;
1190 vcl_mq_dequeue_batch (wrk, mq, ~0);
1192 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
1194 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
1195 e = svm_msg_q_msg_data (mq, msg);
1196 vcl_handle_mq_event (wrk, e);
1197 svm_msg_q_free_msg (mq, msg);
1199 vec_reset_length (wrk->mq_msg_vector);
1200 vcl_handle_pending_wrk_updates (wrk);
1204 vcl_flush_mq_events (void)
1206 vcl_worker_flush_mq_events (vcl_worker_get_current ());
1210 vppcom_session_unbind (u32 session_handle)
1212 vcl_worker_t *wrk = vcl_worker_get_current ();
1213 session_accepted_msg_t *accepted_msg;
1214 vcl_session_t *session = 0;
1215 vcl_session_msg_t *evt;
1217 session = vcl_session_get_w_handle (wrk, session_handle);
1219 return VPPCOM_EBADFD;
1221 /* Flush pending accept events, if any */
1222 while (clib_fifo_elts (session->accept_evts_fifo))
1224 clib_fifo_sub2 (session->accept_evts_fifo, evt);
1225 accepted_msg = &evt->accepted_msg;
1226 vcl_session_table_del_vpp_handle (wrk, accepted_msg->handle);
1227 vcl_send_session_accepted_reply (session->vpp_evt_q,
1228 accepted_msg->context,
1229 accepted_msg->handle, -1);
1231 clib_fifo_free (session->accept_evts_fifo);
1233 vcl_send_session_unlisten (wrk, session);
1235 VDBG (1, "session %u [0x%llx]: sending unbind!", session->session_index,
1236 session->vpp_handle);
1237 vcl_evt (VCL_EVT_UNBIND, session);
1239 session->vpp_handle = ~0;
1240 session->session_state = VCL_STATE_DISCONNECT;
1248 * Notify vpp of the disconnect and mark the worker as free. If we're the
1249 * last worker, do a full cleanup otherwise, since we're probably a forked
1250 * child, avoid syscalls as much as possible. We might've lost privileges.
1253 vppcom_app_exit (void)
1255 if (!pool_elts (vcm->workers))
1257 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
1258 vcl_set_worker_index (~0);
1259 vcl_elog_stop (vcm);
1263 vcl_api_attach (void)
1265 if (vcm->cfg.vpp_app_socket_api)
1266 return vcl_sapi_attach ();
1268 return vcl_bapi_attach ();
1272 vcl_api_retry_attach (vcl_worker_t *wrk)
1276 if (vcl_api_attach ())
1279 /* Treat listeners as configuration that needs to be re-added to vpp */
1280 pool_foreach (s, wrk->sessions)
1282 if (s->flags & VCL_SESSION_F_IS_VEP)
1284 if (s->session_state == VCL_STATE_LISTEN_NO_MQ)
1285 vppcom_session_listen (vcl_session_handle (s), 10);
1287 VDBG (0, "internal error: unexpected state %d", s->session_state);
1292 vcl_api_handle_disconnect (vcl_worker_t *wrk)
1294 wrk->api_client_handle = ~0;
1295 vcl_worker_detach_sessions (wrk);
1299 vcl_api_detach (vcl_worker_t * wrk)
1301 if (wrk->api_client_handle == ~0)
1304 vcl_send_app_detach (wrk);
1306 if (vcm->cfg.vpp_app_socket_api)
1307 return vcl_sapi_detach (wrk);
1309 return vcl_bapi_disconnect_from_vpp ();
1313 * VPPCOM Public API functions
1316 vppcom_app_create (const char *app_name)
1318 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1323 VDBG (1, "already initialized");
1324 return VPPCOM_EEXIST;
1328 vppcom_cfg (&vcm->cfg);
1329 vcl_cfg = &vcm->cfg;
1331 vcm->main_cpu = pthread_self ();
1332 vcm->main_pid = getpid ();
1333 vcm->app_name = format (0, "%s", app_name);
1334 fifo_segment_main_init (&vcm->segment_main, (uword) ~0,
1335 20 /* timeout in secs */);
1336 pool_alloc (vcm->workers, vcl_cfg->max_workers);
1337 clib_spinlock_init (&vcm->workers_lock);
1338 clib_rwlock_init (&vcm->segment_table_lock);
1339 atexit (vppcom_app_exit);
1340 vcl_elog_init (vcm);
1342 /* Allocate default worker */
1343 vcl_worker_alloc_and_init ();
1345 if ((rv = vcl_api_attach ()))
1347 vppcom_app_destroy ();
1351 VDBG (0, "app_name '%s', my_client_index %d (0x%x)", app_name,
1352 vcm->workers[0].api_client_handle, vcm->workers[0].api_client_handle);
1358 vppcom_app_destroy (void)
1360 vcl_worker_t *wrk, *current_wrk;
1363 if (!pool_elts (vcm->workers))
1366 vcl_evt (VCL_EVT_DETACH, vcm);
1368 current_wrk = vcl_worker_get_current ();
1371 pool_foreach (wrk, vcm->workers) {
1372 if (current_wrk != wrk)
1373 vcl_worker_cleanup (wrk, 0 /* notify vpp */ );
1377 vcl_api_detach (current_wrk);
1378 vcl_worker_cleanup (current_wrk, 0 /* notify vpp */ );
1379 vcl_set_worker_index (~0);
1381 vcl_elog_stop (vcm);
1384 * Free the heap and fix vcm
1386 heap = clib_mem_get_heap ();
1387 munmap (clib_mem_get_heap_base (heap), clib_mem_get_heap_size (heap));
1389 vcm = &_vppcom_main;
1394 vppcom_session_create (u8 proto, u8 is_nonblocking)
1396 vcl_worker_t *wrk = vcl_worker_get_current ();
1397 vcl_session_t *session;
1399 session = vcl_session_alloc (wrk);
1401 session->session_type = proto;
1402 session->session_state = VCL_STATE_CLOSED;
1403 session->vpp_handle = ~0;
1404 session->is_dgram = vcl_proto_is_dgram (proto);
1405 session->vpp_error = SESSION_E_NONE;
1408 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
1410 vcl_evt (VCL_EVT_CREATE, session, session_type, session->session_state,
1411 is_nonblocking, session_index);
1413 VDBG (0, "created session %u", session->session_index);
1415 return vcl_session_handle (session);
1419 vcl_epoll_lt_add (vcl_worker_t *wrk, vcl_session_t *s)
1421 vcl_session_t *cur, *prev;
1423 if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX)
1425 wrk->ep_lt_current = s->session_index;
1426 s->vep.lt_next = s->session_index;
1427 s->vep.lt_prev = s->session_index;
1431 cur = vcl_session_get (wrk, wrk->ep_lt_current);
1432 prev = vcl_session_get (wrk, cur->vep.lt_prev);
1434 prev->vep.lt_next = s->session_index;
1435 s->vep.lt_prev = prev->session_index;
1437 s->vep.lt_next = cur->session_index;
1438 cur->vep.lt_prev = s->session_index;
1442 vcl_epoll_lt_del (vcl_worker_t *wrk, vcl_session_t *s)
1444 vcl_session_t *prev, *next;
1446 if (s->vep.lt_next == s->session_index)
1448 wrk->ep_lt_current = VCL_INVALID_SESSION_INDEX;
1449 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
1453 prev = vcl_session_get (wrk, s->vep.lt_prev);
1454 next = vcl_session_get (wrk, s->vep.lt_next);
1456 prev->vep.lt_next = next->session_index;
1457 next->vep.lt_prev = prev->session_index;
1459 if (s->session_index == wrk->ep_lt_current)
1460 wrk->ep_lt_current = s->vep.lt_next;
1462 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
1466 vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * s,
1467 vcl_session_handle_t sh, u8 do_disconnect)
1471 VDBG (1, "session %u [0x%llx] closing", s->session_index, s->vpp_handle);
1473 if (s->flags & VCL_SESSION_F_IS_VEP)
1475 u32 next_sh = s->vep.next_sh;
1476 while (next_sh != ~0)
1478 rv = vppcom_epoll_ctl (sh, EPOLL_CTL_DEL, next_sh, 0);
1479 if (PREDICT_FALSE (rv < 0))
1480 VDBG (0, "vpp handle 0x%llx, sh %u: EPOLL_CTL_DEL vep_idx %u"
1481 " failed! rv %d (%s)", s->vpp_handle, next_sh,
1482 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1483 next_sh = s->vep.next_sh;
1488 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
1490 rv = vppcom_epoll_ctl (s->vep.vep_sh, EPOLL_CTL_DEL, sh, 0);
1492 VDBG (0, "session %u [0x%llx]: EPOLL_CTL_DEL vep_idx %u "
1493 "failed! rv %d (%s)", s->session_index, s->vpp_handle,
1494 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1499 VDBG (1, "session %u [0x%llx] disconnect skipped",
1500 s->session_index, s->vpp_handle);
1504 if (s->session_state == VCL_STATE_LISTEN)
1506 rv = vppcom_session_unbind (sh);
1507 if (PREDICT_FALSE (rv < 0))
1508 VDBG (0, "session %u [0x%llx]: listener unbind failed! "
1509 "rv %d (%s)", s->session_index, s->vpp_handle, rv,
1510 vppcom_retval_str (rv));
1513 else if (vcl_session_is_ready (s)
1514 || (vcl_session_is_connectable_listener (wrk, s)))
1516 rv = vppcom_session_disconnect (sh);
1517 if (PREDICT_FALSE (rv < 0))
1518 VDBG (0, "ERROR: session %u [0x%llx]: disconnect failed!"
1519 " rv %d (%s)", s->session_index, s->vpp_handle,
1520 rv, vppcom_retval_str (rv));
1522 else if (s->session_state == VCL_STATE_DISCONNECT)
1524 vcl_send_session_reset_reply (wrk, s, 0);
1526 else if (s->session_state == VCL_STATE_DETACHED)
1528 VDBG (0, "vpp freed session %d before close", s->session_index);
1530 if (!(s->flags & VCL_SESSION_F_PENDING_DISCONNECT))
1533 /* Disconnect/reset messages pending but vpp transport and session
1534 * cleanups already done. Free only after messages drained. */
1535 s->flags |= VCL_SESSION_F_PENDING_FREE;
1538 s->session_state = VCL_STATE_CLOSED;
1540 /* Session is removed only after vpp confirms the disconnect */
1544 vcl_session_table_del_vpp_handle (wrk, s->vpp_handle);
1546 vcl_session_free (wrk, s);
1547 vcl_evt (VCL_EVT_CLOSE, s, rv);
1553 vppcom_session_close (uint32_t session_handle)
1555 vcl_worker_t *wrk = vcl_worker_get_current ();
1556 vcl_session_t *session;
1558 session = vcl_session_get_w_handle (wrk, session_handle);
1560 return VPPCOM_EBADFD;
1561 return vcl_session_cleanup (wrk, session, session_handle,
1562 1 /* do_disconnect */ );
1566 vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep)
1568 vcl_worker_t *wrk = vcl_worker_get_current ();
1569 vcl_session_t *session = 0;
1572 return VPPCOM_EINVAL;
1574 session = vcl_session_get_w_handle (wrk, session_handle);
1576 return VPPCOM_EBADFD;
1578 if (session->flags & VCL_SESSION_F_IS_VEP)
1580 VDBG (0, "ERROR: cannot bind to epoll session %u!",
1581 session->session_index);
1582 return VPPCOM_EBADFD;
1585 session->transport.is_ip4 = ep->is_ip4;
1587 clib_memcpy_fast (&session->transport.lcl_ip.ip4, ep->ip,
1588 sizeof (ip4_address_t));
1590 clib_memcpy_fast (&session->transport.lcl_ip.ip6, ep->ip,
1591 sizeof (ip6_address_t));
1592 session->transport.lcl_port = ep->port;
1595 "session %u handle %u: binding to local %s address %U port %u, "
1597 session->session_index, session_handle,
1598 session->transport.is_ip4 ? "IPv4" : "IPv6", vcl_format_ip46_address,
1599 &session->transport.lcl_ip,
1600 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1601 clib_net_to_host_u16 (session->transport.lcl_port),
1602 vppcom_proto_str (session->session_type));
1603 vcl_evt (VCL_EVT_BIND, session);
1605 if (session->session_type == VPPCOM_PROTO_UDP)
1606 vppcom_session_listen (session_handle, 10);
1612 vppcom_session_listen (uint32_t listen_sh, uint32_t q_len)
1614 vcl_worker_t *wrk = vcl_worker_get_current ();
1615 vcl_session_t *listen_session = 0;
1616 u64 listen_vpp_handle;
1619 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1620 if (!listen_session || (listen_session->flags & VCL_SESSION_F_IS_VEP))
1621 return VPPCOM_EBADFD;
1623 listen_vpp_handle = listen_session->vpp_handle;
1624 if (listen_session->session_state == VCL_STATE_LISTEN)
1626 VDBG (0, "session %u [0x%llx]: already in listen state!",
1627 listen_sh, listen_vpp_handle);
1631 VDBG (0, "session %u: sending vpp listen request...", listen_sh);
1634 * Send listen request to vpp and wait for reply
1636 vcl_send_session_listen (wrk, listen_session);
1637 rv = vppcom_wait_for_session_state_change (listen_session->session_index,
1639 vcm->cfg.session_timeout);
1641 if (PREDICT_FALSE (rv))
1643 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1644 VDBG (0, "session %u [0x%llx]: listen failed! returning %d (%s)",
1645 listen_sh, listen_session->vpp_handle, rv,
1646 vppcom_retval_str (rv));
1654 validate_args_session_accept_ (vcl_worker_t * wrk, vcl_session_t * ls)
1656 if (ls->flags & VCL_SESSION_F_IS_VEP)
1658 VDBG (0, "ERROR: cannot accept on epoll session %u!",
1660 return VPPCOM_EBADFD;
1663 if ((ls->session_state != VCL_STATE_LISTEN)
1664 && (!vcl_session_is_connectable_listener (wrk, ls)))
1667 "ERROR: session [0x%llx]: not in listen state! state 0x%x"
1669 ls->vpp_handle, ls->session_state,
1670 vcl_session_state_str (ls->session_state));
1671 return VPPCOM_EBADFD;
1677 vppcom_unformat_proto (uint8_t * proto, char *proto_str)
1679 if (!strcmp (proto_str, "TCP"))
1680 *proto = VPPCOM_PROTO_TCP;
1681 else if (!strcmp (proto_str, "tcp"))
1682 *proto = VPPCOM_PROTO_TCP;
1683 else if (!strcmp (proto_str, "UDP"))
1684 *proto = VPPCOM_PROTO_UDP;
1685 else if (!strcmp (proto_str, "udp"))
1686 *proto = VPPCOM_PROTO_UDP;
1687 else if (!strcmp (proto_str, "TLS"))
1688 *proto = VPPCOM_PROTO_TLS;
1689 else if (!strcmp (proto_str, "tls"))
1690 *proto = VPPCOM_PROTO_TLS;
1691 else if (!strcmp (proto_str, "QUIC"))
1692 *proto = VPPCOM_PROTO_QUIC;
1693 else if (!strcmp (proto_str, "quic"))
1694 *proto = VPPCOM_PROTO_QUIC;
1695 else if (!strcmp (proto_str, "DTLS"))
1696 *proto = VPPCOM_PROTO_DTLS;
1697 else if (!strcmp (proto_str, "dtls"))
1698 *proto = VPPCOM_PROTO_DTLS;
1699 else if (!strcmp (proto_str, "SRTP"))
1700 *proto = VPPCOM_PROTO_SRTP;
1701 else if (!strcmp (proto_str, "srtp"))
1702 *proto = VPPCOM_PROTO_SRTP;
1709 vppcom_session_accept (uint32_t listen_session_handle, vppcom_endpt_t * ep,
1712 u32 client_session_index = ~0, listen_session_index, accept_flags = 0;
1713 vcl_worker_t *wrk = vcl_worker_get_current ();
1714 session_accepted_msg_t accepted_msg;
1715 vcl_session_t *listen_session = 0;
1716 vcl_session_t *client_session = 0;
1717 vcl_session_msg_t *evt;
1723 listen_session = vcl_session_get_w_handle (wrk, listen_session_handle);
1724 if (!listen_session)
1725 return VPPCOM_EBADFD;
1727 listen_session_index = listen_session->session_index;
1728 if ((rv = validate_args_session_accept_ (wrk, listen_session)))
1731 if (clib_fifo_elts (listen_session->accept_evts_fifo))
1733 clib_fifo_sub2 (listen_session->accept_evts_fifo, evt);
1734 accept_flags = evt->flags;
1735 accepted_msg = evt->accepted_msg;
1739 is_nonblocking = vcl_session_has_attr (listen_session,
1740 VCL_SESS_ATTR_NONBLOCK);
1743 if (svm_msg_q_is_empty (wrk->app_event_queue) && is_nonblocking)
1744 return VPPCOM_EAGAIN;
1746 svm_msg_q_wait (wrk->app_event_queue, SVM_MQ_WAIT_EMPTY);
1747 vcl_worker_flush_mq_events (wrk);
1753 client_session_index = vcl_session_accepted_handler (wrk, &accepted_msg,
1754 listen_session_index);
1755 if (client_session_index == VCL_INVALID_SESSION_INDEX)
1756 return VPPCOM_ECONNABORTED;
1758 listen_session = vcl_session_get (wrk, listen_session_index);
1759 client_session = vcl_session_get (wrk, client_session_index);
1761 if (flags & O_NONBLOCK)
1762 vcl_session_set_attr (client_session, VCL_SESS_ATTR_NONBLOCK);
1764 VDBG (1, "listener %u [0x%llx]: Got a connect request! session %u [0x%llx],"
1765 " flags %d, is_nonblocking %u", listen_session->session_index,
1766 listen_session->vpp_handle, client_session_index,
1767 client_session->vpp_handle, flags,
1768 vcl_session_has_attr (client_session, VCL_SESS_ATTR_NONBLOCK));
1772 ep->is_ip4 = client_session->transport.is_ip4;
1773 ep->port = client_session->transport.rmt_port;
1774 if (client_session->transport.is_ip4)
1775 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip4,
1776 sizeof (ip4_address_t));
1778 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip6,
1779 sizeof (ip6_address_t));
1783 "listener %u [0x%llx] accepted %u [0x%llx] peer: %U:%u "
1785 listen_session_handle, listen_session->vpp_handle,
1786 client_session_index, client_session->vpp_handle,
1787 vcl_format_ip46_address, &client_session->transport.rmt_ip,
1788 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1789 clib_net_to_host_u16 (client_session->transport.rmt_port),
1790 vcl_format_ip46_address, &client_session->transport.lcl_ip,
1791 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1792 clib_net_to_host_u16 (client_session->transport.lcl_port));
1793 vcl_evt (VCL_EVT_ACCEPT, client_session, listen_session,
1794 client_session_index);
1797 * Session might have been closed already
1801 if (accept_flags & VCL_ACCEPTED_F_CLOSED)
1802 client_session->session_state = VCL_STATE_VPP_CLOSING;
1803 else if (accept_flags & VCL_ACCEPTED_F_RESET)
1804 client_session->session_state = VCL_STATE_DISCONNECT;
1806 return vcl_session_handle (client_session);
1810 vppcom_session_connect (uint32_t session_handle, vppcom_endpt_t * server_ep)
1812 vcl_worker_t *wrk = vcl_worker_get_current ();
1813 vcl_session_t *session = 0;
1817 session = vcl_session_get_w_handle (wrk, session_handle);
1819 return VPPCOM_EBADFD;
1820 session_index = session->session_index;
1822 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1824 VWRN ("cannot connect epoll session %u!", session->session_index);
1825 return VPPCOM_EBADFD;
1828 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1831 "session %u [0x%llx]: already connected to %U:%d proto %s,"
1833 session->session_index, session->vpp_handle,
1834 vcl_format_ip46_address, &session->transport.rmt_ip,
1835 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1836 clib_net_to_host_u16 (session->transport.rmt_port),
1837 vppcom_proto_str (session->session_type),
1838 vcl_session_state_str (session->session_state));
1842 /* Attempt to connect a connectionless listener */
1843 if (PREDICT_FALSE (session->session_state == VCL_STATE_LISTEN))
1845 if (session->session_type != VPPCOM_PROTO_UDP)
1846 return VPPCOM_EINVAL;
1847 vcl_send_session_unlisten (wrk, session);
1848 session->session_state = VCL_STATE_CLOSED;
1851 session->transport.is_ip4 = server_ep->is_ip4;
1852 vcl_ip_copy_from_ep (&session->transport.rmt_ip, server_ep);
1853 session->transport.rmt_port = server_ep->port;
1854 session->parent_handle = VCL_INVALID_SESSION_HANDLE;
1855 session->flags |= VCL_SESSION_F_CONNECTED;
1857 VDBG (0, "session %u: connecting to peer %U:%d proto %s",
1858 session->session_index, vcl_format_ip46_address,
1859 &session->transport.rmt_ip,
1860 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1861 clib_net_to_host_u16 (session->transport.rmt_port),
1862 vppcom_proto_str (session->session_type));
1864 vcl_send_session_connect (wrk, session);
1866 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK))
1868 /* State set to STATE_UPDATED to ensure the session is not assumed
1869 * to be ready and to also allow the app to close it prior to vpp's
1870 * connected reply. */
1871 session->session_state = VCL_STATE_UPDATED;
1872 return VPPCOM_EINPROGRESS;
1876 * Wait for reply from vpp if blocking
1878 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1879 vcm->cfg.session_timeout);
1881 session = vcl_session_get (wrk, session_index);
1882 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1883 session->vpp_handle, rv ? "failed" : "succeeded");
1889 vppcom_session_stream_connect (uint32_t session_handle,
1890 uint32_t parent_session_handle)
1892 vcl_worker_t *wrk = vcl_worker_get_current ();
1893 vcl_session_t *session, *parent_session;
1894 u32 session_index, parent_session_index;
1897 session = vcl_session_get_w_handle (wrk, session_handle);
1899 return VPPCOM_EBADFD;
1900 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1901 if (!parent_session)
1902 return VPPCOM_EBADFD;
1904 session_index = session->session_index;
1905 parent_session_index = parent_session->session_index;
1906 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1908 VDBG (0, "ERROR: cannot connect epoll session %u!",
1909 session->session_index);
1910 return VPPCOM_EBADFD;
1913 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1916 "session handle %u [0x%llx]: session already "
1917 "connected to session %u [0x%llx] proto %s, state 0x%x (%s)",
1918 session_handle, session->vpp_handle, parent_session_handle,
1919 parent_session->vpp_handle,
1920 vppcom_proto_str (session->session_type), session->session_state,
1921 vcl_session_state_str (session->session_state));
1925 /* Connect to quic session specifics */
1926 session->transport.is_ip4 = parent_session->transport.is_ip4;
1927 session->transport.rmt_ip.ip4.as_u32 = (uint32_t) 1;
1928 session->transport.rmt_port = 0;
1929 session->parent_handle = parent_session->vpp_handle;
1931 VDBG (0, "session handle %u: connecting to session %u [0x%llx]",
1932 session_handle, parent_session_handle, parent_session->vpp_handle);
1935 * Send connect request and wait for reply from vpp
1937 vcl_send_session_connect (wrk, session);
1938 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1939 vcm->cfg.session_timeout);
1941 session->listener_index = parent_session_index;
1942 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1944 parent_session->n_accepted_sessions++;
1946 session = vcl_session_get (wrk, session_index);
1947 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1948 session->vpp_handle, rv ? "failed" : "succeeded");
1954 vppcom_session_read_internal (uint32_t session_handle, void *buf, int n,
1957 vcl_worker_t *wrk = vcl_worker_get_current ();
1958 int rv, n_read = 0, is_nonblocking;
1959 vcl_session_t *s = 0;
1960 svm_fifo_t *rx_fifo;
1965 if (PREDICT_FALSE (!buf))
1966 return VPPCOM_EFAULT;
1968 s = vcl_session_get_w_handle (wrk, session_handle);
1969 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
1970 return VPPCOM_EBADFD;
1972 if (PREDICT_FALSE (!vcl_session_is_open (s)))
1974 VDBG (0, "session %u[0x%llx] is not open! state 0x%x (%s)",
1975 s->session_index, s->vpp_handle, s->session_state,
1976 vcl_session_state_str (s->session_state));
1977 return vcl_session_closed_error (s);
1980 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_RD_SHUTDOWN))
1982 /* Vpp would ack the incoming data and enqueue it for reading.
1983 * So even if SHUT_RD is set, we can still read() the data if
1984 * the session is ready.
1986 if (!vcl_session_read_ready (s))
1992 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
1993 is_ct = vcl_session_is_ct (s);
1994 mq = wrk->app_event_queue;
1995 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
1996 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
1998 if (svm_fifo_is_empty_cons (rx_fifo))
2002 if (vcl_session_is_closing (s))
2003 return vcl_session_closing_error (s);
2005 svm_fifo_unset_event (s->rx_fifo);
2006 svm_fifo_unset_event (rx_fifo);
2007 return VPPCOM_EWOULDBLOCK;
2009 while (svm_fifo_is_empty_cons (rx_fifo))
2011 if (vcl_session_is_closing (s))
2012 return vcl_session_closing_error (s);
2015 svm_fifo_unset_event (s->rx_fifo);
2016 svm_fifo_unset_event (rx_fifo);
2018 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2019 vcl_worker_flush_mq_events (wrk);
2026 rv = app_recv_dgram_raw (rx_fifo, buf, n, &s->transport, 0, peek);
2028 rv = app_recv_stream_raw (rx_fifo, buf, n, 0, peek);
2037 if (svm_fifo_is_empty_cons (rx_fifo))
2040 svm_fifo_unset_event (s->rx_fifo);
2041 svm_fifo_unset_event (rx_fifo);
2042 if (!svm_fifo_is_empty_cons (rx_fifo)
2043 && svm_fifo_set_event (rx_fifo) && is_nonblocking)
2045 vec_add2 (wrk->unhandled_evts_vector, e, 1);
2046 e->event_type = SESSION_IO_EVT_RX;
2047 e->session_index = s->session_index;
2050 else if (PREDICT_FALSE (rv < n && !s->is_dgram))
2052 /* More data enqueued while reading. Try to drain it
2053 * or fill the buffer. Avoid doing that for dgrams */
2059 if (PREDICT_FALSE (svm_fifo_needs_deq_ntf (rx_fifo, n_read)))
2061 svm_fifo_clear_deq_ntf (rx_fifo);
2062 app_send_io_evt_to_vpp (s->vpp_evt_q,
2063 s->rx_fifo->shr->master_session_index,
2064 SESSION_IO_EVT_RX, SVM_Q_WAIT);
2067 VDBG (2, "session %u[0x%llx]: read %d bytes from (%p)", s->session_index,
2068 s->vpp_handle, n_read, rx_fifo);
2074 vppcom_session_read (uint32_t session_handle, void *buf, size_t n)
2076 return (vppcom_session_read_internal (session_handle, buf, n, 0));
2080 vppcom_session_peek (uint32_t session_handle, void *buf, int n)
2082 return (vppcom_session_read_internal (session_handle, buf, n, 1));
2086 vppcom_session_read_segments (uint32_t session_handle,
2087 vppcom_data_segment_t * ds, uint32_t n_segments,
2090 vcl_worker_t *wrk = vcl_worker_get_current ();
2091 int n_read = 0, is_nonblocking;
2092 vcl_session_t *s = 0;
2093 svm_fifo_t *rx_fifo;
2097 s = vcl_session_get_w_handle (wrk, session_handle);
2098 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2099 return VPPCOM_EBADFD;
2101 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2102 return vcl_session_closed_error (s);
2104 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2105 is_ct = vcl_session_is_ct (s);
2106 mq = wrk->app_event_queue;
2107 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
2108 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2110 if (svm_fifo_is_empty_cons (rx_fifo))
2115 svm_fifo_unset_event (s->rx_fifo);
2116 svm_fifo_unset_event (rx_fifo);
2117 return VPPCOM_EWOULDBLOCK;
2119 while (svm_fifo_is_empty_cons (rx_fifo))
2121 if (vcl_session_is_closing (s))
2122 return vcl_session_closing_error (s);
2125 svm_fifo_unset_event (s->rx_fifo);
2126 svm_fifo_unset_event (rx_fifo);
2128 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2129 vcl_worker_flush_mq_events (wrk);
2133 n_read = svm_fifo_segments (rx_fifo, s->rx_bytes_pending,
2134 (svm_fifo_seg_t *) ds, &n_segments, max_bytes);
2136 return VPPCOM_EAGAIN;
2138 if (svm_fifo_max_dequeue_cons (rx_fifo) == n_read)
2141 svm_fifo_unset_event (s->rx_fifo);
2142 svm_fifo_unset_event (rx_fifo);
2143 if (svm_fifo_max_dequeue_cons (rx_fifo) != n_read
2144 && svm_fifo_set_event (rx_fifo)
2145 && vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
2148 vec_add2 (wrk->unhandled_evts_vector, e, 1);
2149 e->event_type = SESSION_IO_EVT_RX;
2150 e->session_index = s->session_index;
2154 s->rx_bytes_pending += n_read;
2159 vppcom_session_free_segments (uint32_t session_handle, uint32_t n_bytes)
2161 vcl_worker_t *wrk = vcl_worker_get_current ();
2165 s = vcl_session_get_w_handle (wrk, session_handle);
2166 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2169 is_ct = vcl_session_is_ct (s);
2170 svm_fifo_dequeue_drop (is_ct ? s->ct_rx_fifo : s->rx_fifo, n_bytes);
2172 ASSERT (s->rx_bytes_pending >= n_bytes);
2173 s->rx_bytes_pending -= n_bytes;
2177 vcl_fifo_is_writeable (svm_fifo_t * f, u32 len, u8 is_dgram)
2179 u32 max_enq = svm_fifo_max_enqueue_prod (f);
2181 return max_enq >= (sizeof (session_dgram_hdr_t) + len);
2187 vppcom_session_write_inline (vcl_worker_t * wrk, vcl_session_t * s, void *buf,
2188 size_t n, u8 is_flush, u8 is_dgram)
2190 int n_write, is_nonblocking;
2191 session_evt_type_t et;
2192 svm_fifo_t *tx_fifo;
2196 /* Accept zero length writes but just return */
2197 if (PREDICT_FALSE (!n))
2200 if (PREDICT_FALSE (!buf))
2201 return VPPCOM_EFAULT;
2203 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2205 VDBG (0, "ERROR: session %u [0x%llx]: cannot write to an epoll"
2206 " session!", s->session_index, s->vpp_handle);
2207 return VPPCOM_EBADFD;
2210 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2212 VDBG (1, "session %u [0x%llx]: is not open! state 0x%x (%s)",
2213 s->session_index, s->vpp_handle, s->session_state,
2214 vcl_session_state_str (s->session_state));
2215 return vcl_session_closed_error (s);;
2218 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_WR_SHUTDOWN))
2220 VDBG (1, "session %u [0x%llx]: is shutdown! state 0x%x (%s)",
2221 s->session_index, s->vpp_handle, s->session_state,
2222 vcl_session_state_str (s->session_state));
2223 return VPPCOM_EPIPE;
2226 is_ct = vcl_session_is_ct (s);
2227 tx_fifo = is_ct ? s->ct_tx_fifo : s->tx_fifo;
2228 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2230 mq = wrk->app_event_queue;
2231 if (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2235 return VPPCOM_EWOULDBLOCK;
2237 while (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2239 svm_fifo_add_want_deq_ntf (tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
2240 if (vcl_session_is_closing (s))
2241 return vcl_session_closing_error (s);
2243 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2244 vcl_worker_flush_mq_events (wrk);
2248 et = SESSION_IO_EVT_TX;
2249 if (is_flush && !is_ct)
2250 et = SESSION_IO_EVT_TX_FLUSH;
2253 n_write = app_send_dgram_raw (tx_fifo, &s->transport,
2254 s->vpp_evt_q, buf, n, et,
2255 0 /* do_evt */ , SVM_Q_WAIT);
2257 n_write = app_send_stream_raw (tx_fifo, s->vpp_evt_q, buf, n, et,
2258 0 /* do_evt */ , SVM_Q_WAIT);
2260 if (svm_fifo_set_event (s->tx_fifo))
2261 app_send_io_evt_to_vpp (
2262 s->vpp_evt_q, s->tx_fifo->shr->master_session_index, et, SVM_Q_WAIT);
2264 /* The underlying fifo segment can run out of memory */
2265 if (PREDICT_FALSE (n_write < 0))
2266 return VPPCOM_EAGAIN;
2268 VDBG (2, "session %u [0x%llx]: wrote %d bytes", s->session_index,
2269 s->vpp_handle, n_write);
2275 vppcom_session_write (uint32_t session_handle, void *buf, size_t n)
2277 vcl_worker_t *wrk = vcl_worker_get_current ();
2280 s = vcl_session_get_w_handle (wrk, session_handle);
2281 if (PREDICT_FALSE (!s))
2282 return VPPCOM_EBADFD;
2284 return vppcom_session_write_inline (wrk, s, buf, n,
2285 0 /* is_flush */ , s->is_dgram ? 1 : 0);
2289 vppcom_session_write_msg (uint32_t session_handle, void *buf, size_t n)
2291 vcl_worker_t *wrk = vcl_worker_get_current ();
2294 s = vcl_session_get_w_handle (wrk, session_handle);
2295 if (PREDICT_FALSE (!s))
2296 return VPPCOM_EBADFD;
2298 return vppcom_session_write_inline (wrk, s, buf, n,
2299 1 /* is_flush */ , s->is_dgram ? 1 : 0);
2302 #define vcl_fifo_rx_evt_valid_or_break(_s) \
2303 if (PREDICT_FALSE (!_s->rx_fifo)) \
2305 if (PREDICT_FALSE (svm_fifo_is_empty (_s->rx_fifo))) \
2307 if (!vcl_session_is_ct (_s)) \
2309 svm_fifo_unset_event (_s->rx_fifo); \
2310 if (svm_fifo_is_empty (_s->rx_fifo)) \
2313 else if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2315 svm_fifo_unset_event (_s->rx_fifo); /* rx evts on actual fifo*/ \
2316 if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2322 vcl_select_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2323 unsigned long n_bits, unsigned long *read_map,
2324 unsigned long *write_map,
2325 unsigned long *except_map, u32 * bits_set)
2327 session_disconnected_msg_t *disconnected_msg;
2328 session_connected_msg_t *connected_msg;
2332 switch (e->event_type)
2334 case SESSION_IO_EVT_RX:
2335 sid = e->session_index;
2336 s = vcl_session_get (wrk, sid);
2337 if (!s || !vcl_session_is_open (s))
2339 vcl_fifo_rx_evt_valid_or_break (s);
2340 if (sid < n_bits && read_map)
2342 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2346 case SESSION_IO_EVT_TX:
2347 sid = e->session_index;
2348 s = vcl_session_get (wrk, sid);
2349 if (!s || !vcl_session_is_open (s))
2351 if (sid < n_bits && write_map)
2353 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2357 case SESSION_CTRL_EVT_ACCEPTED:
2359 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
2361 s = vcl_session_get (wrk, e->session_index);
2364 sid = s->session_index;
2365 if (sid < n_bits && read_map)
2367 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2371 case SESSION_CTRL_EVT_CONNECTED:
2374 connected_msg = (session_connected_msg_t *) e->data;
2375 sid = vcl_session_connected_handler (wrk, connected_msg);
2378 sid = e->session_index;
2379 if (sid == VCL_INVALID_SESSION_INDEX)
2381 if (sid < n_bits && write_map)
2383 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2387 case SESSION_CTRL_EVT_DISCONNECTED:
2388 disconnected_msg = (session_disconnected_msg_t *) e->data;
2389 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
2392 sid = s->session_index;
2393 if (sid < n_bits && except_map)
2395 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2399 case SESSION_CTRL_EVT_RESET:
2400 sid = vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
2401 if (sid < n_bits && except_map)
2403 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2407 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
2408 vcl_session_unlisten_reply_handler (wrk, e->data);
2410 case SESSION_CTRL_EVT_MIGRATED:
2411 vcl_session_migrated_handler (wrk, e->data);
2413 case SESSION_CTRL_EVT_CLEANUP:
2414 vcl_session_cleanup_handler (wrk, e->data);
2416 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
2417 vcl_session_worker_update_reply_handler (wrk, e->data);
2419 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
2420 vcl_session_req_worker_update_handler (wrk, e->data);
2422 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
2423 vcl_session_app_add_segment_handler (wrk, e->data);
2425 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
2426 vcl_session_app_del_segment_handler (wrk, e->data);
2428 case SESSION_CTRL_EVT_APP_WRK_RPC:
2429 vcl_worker_rpc_handler (wrk, e->data);
2432 clib_warning ("unhandled: %u", e->event_type);
2438 vcl_select_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
2439 unsigned long n_bits, unsigned long *read_map,
2440 unsigned long *write_map, unsigned long *except_map,
2441 double time_to_wait, u32 * bits_set)
2443 svm_msg_q_msg_t *msg;
2447 if (svm_msg_q_is_empty (mq))
2454 else if (time_to_wait < 0)
2455 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2458 if (svm_msg_q_timedwait (mq, time_to_wait))
2462 vcl_mq_dequeue_batch (wrk, mq, ~0);
2464 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
2466 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
2467 e = svm_msg_q_msg_data (mq, msg);
2468 vcl_select_handle_mq_event (wrk, e, n_bits, read_map, write_map,
2469 except_map, bits_set);
2470 svm_msg_q_free_msg (mq, msg);
2472 vec_reset_length (wrk->mq_msg_vector);
2473 vcl_handle_pending_wrk_updates (wrk);
2478 vppcom_select_condvar (vcl_worker_t * wrk, int n_bits,
2479 vcl_si_set * read_map, vcl_si_set * write_map,
2480 vcl_si_set * except_map, double time_to_wait,
2483 double wait = 0, start = 0;
2487 wait = time_to_wait;
2488 start = clib_time_now (&wrk->clib_time);
2493 vcl_select_handle_mq (wrk, wrk->app_event_queue, n_bits, read_map,
2494 write_map, except_map, wait, bits_set);
2500 wait = wait - (clib_time_now (&wrk->clib_time) - start);
2508 vppcom_select_eventfd (vcl_worker_t * wrk, int n_bits,
2509 vcl_si_set * read_map, vcl_si_set * write_map,
2510 vcl_si_set * except_map, double time_to_wait,
2513 vcl_mq_evt_conn_t *mqc;
2514 int __clib_unused n_read;
2518 if (PREDICT_FALSE (wrk->api_client_handle == ~0))
2520 vcl_api_retry_attach (wrk);
2524 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
2525 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
2526 vec_len (wrk->mq_events), time_to_wait);
2527 for (i = 0; i < n_mq_evts; i++)
2529 if (PREDICT_FALSE (wrk->mq_events[i].data.u32 == ~0))
2531 vcl_api_handle_disconnect (wrk);
2535 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
2536 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
2537 vcl_select_handle_mq (wrk, mqc->mq, n_bits, read_map, write_map,
2538 except_map, 0, bits_set);
2541 return (n_mq_evts > 0 ? (int) *bits_set : 0);
2545 vppcom_select (int n_bits, vcl_si_set * read_map, vcl_si_set * write_map,
2546 vcl_si_set * except_map, double time_to_wait)
2548 u32 sid, minbits = clib_max (n_bits, BITS (uword)), bits_set = 0;
2549 vcl_worker_t *wrk = vcl_worker_get_current ();
2550 vcl_session_t *s = 0;
2553 if (n_bits && read_map)
2555 clib_bitmap_validate (wrk->rd_bitmap, minbits);
2556 clib_memcpy_fast (wrk->rd_bitmap, read_map,
2557 vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2558 memset (read_map, 0, vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2560 if (n_bits && write_map)
2562 clib_bitmap_validate (wrk->wr_bitmap, minbits);
2563 clib_memcpy_fast (wrk->wr_bitmap, write_map,
2564 vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2565 memset (write_map, 0, vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2567 if (n_bits && except_map)
2569 clib_bitmap_validate (wrk->ex_bitmap, minbits);
2570 clib_memcpy_fast (wrk->ex_bitmap, except_map,
2571 vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2572 memset (except_map, 0, vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2581 clib_bitmap_foreach (sid, wrk->wr_bitmap)
2583 if (!(s = vcl_session_get (wrk, sid)))
2585 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2590 if (vcl_session_write_ready (s))
2592 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2597 svm_fifo_t *txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2598 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF);
2606 clib_bitmap_foreach (sid, wrk->rd_bitmap)
2608 if (!(s = vcl_session_get (wrk, sid)))
2610 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2615 if (vcl_session_read_ready (s))
2617 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2624 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
2626 vcl_select_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i], n_bits,
2627 read_map, write_map, except_map, &bits_set);
2629 vec_reset_length (wrk->unhandled_evts_vector);
2631 if (vcm->cfg.use_mq_eventfd)
2632 vppcom_select_eventfd (wrk, n_bits, read_map, write_map, except_map,
2633 time_to_wait, &bits_set);
2635 vppcom_select_condvar (wrk, n_bits, read_map, write_map, except_map,
2636 time_to_wait, &bits_set);
2642 vep_verify_epoll_chain (vcl_worker_t * wrk, u32 vep_handle)
2644 vppcom_epoll_t *vep;
2645 u32 sh = vep_handle;
2648 if (VPPCOM_DEBUG <= 2)
2651 s = vcl_session_get_w_handle (wrk, vep_handle);
2652 if (PREDICT_FALSE (!s))
2654 VDBG (0, "ERROR: Invalid vep_sh (%u)!", vep_handle);
2657 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP)))
2659 VDBG (0, "ERROR: vep_sh (%u) is not a vep!", vep_handle);
2663 VDBG (0, "vep_sh (%u): Dumping epoll chain\n"
2666 " is_vep_session = %u\n"
2667 " next_sh = 0x%x (%u)\n"
2668 "}\n", vep_handle, s->flags & VCL_SESSION_F_IS_VEP,
2669 s->flags & VCL_SESSION_F_IS_VEP_SESSION, vep->next_sh, vep->next_sh);
2671 for (sh = vep->next_sh; sh != ~0; sh = vep->next_sh)
2673 s = vcl_session_get_w_handle (wrk, sh);
2674 if (PREDICT_FALSE (!s))
2676 VDBG (0, "ERROR: Invalid sh (%u)!", sh);
2679 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2681 VDBG (0, "ERROR: sh (%u) is a vep!", vep_handle);
2683 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2685 VDBG (0, "ERROR: sh (%u) is not a vep session handle!", sh);
2689 if (PREDICT_FALSE (vep->vep_sh != vep_handle))
2690 VDBG (0, "ERROR: session (%u) vep_sh (%u) != vep_sh (%u)!",
2691 sh, s->vep.vep_sh, vep_handle);
2692 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2694 VDBG (0, "vep_sh[%u]: sh 0x%x (%u)\n"
2696 " next_sh = 0x%x (%u)\n"
2697 " prev_sh = 0x%x (%u)\n"
2698 " vep_sh = 0x%x (%u)\n"
2699 " ev.events = 0x%x\n"
2700 " ev.data.u64 = 0x%llx\n"
2703 vep_handle, sh, sh, vep->next_sh, vep->next_sh, vep->prev_sh,
2704 vep->prev_sh, vep->vep_sh, vep->vep_sh, vep->ev.events,
2705 vep->ev.data.u64, vep->et_mask);
2710 VDBG (0, "vep_sh (%u): Dump complete!\n", vep_handle);
2714 vppcom_epoll_create (void)
2716 vcl_worker_t *wrk = vcl_worker_get_current ();
2717 vcl_session_t *vep_session;
2719 vep_session = vcl_session_alloc (wrk);
2721 vep_session->flags |= VCL_SESSION_F_IS_VEP;
2722 vep_session->vep.vep_sh = ~0;
2723 vep_session->vep.next_sh = ~0;
2724 vep_session->vep.prev_sh = ~0;
2725 vep_session->vpp_handle = ~0;
2727 vcl_evt (VCL_EVT_EPOLL_CREATE, vep_session, vep_session->session_index);
2728 VDBG (0, "Created vep_idx %u", vep_session->session_index);
2730 return vcl_session_handle (vep_session);
2734 vppcom_epoll_ctl (uint32_t vep_handle, int op, uint32_t session_handle,
2735 struct epoll_event *event)
2737 vcl_worker_t *wrk = vcl_worker_get_current ();
2738 int rv = VPPCOM_OK, add_evt = 0;
2739 vcl_session_t *vep_session;
2743 if (vep_handle == session_handle)
2745 VDBG (0, "vep_sh == session handle (%u)!", vep_handle);
2746 return VPPCOM_EINVAL;
2749 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
2750 if (PREDICT_FALSE (!vep_session))
2752 VDBG (0, "Invalid vep_sh (%u)!", vep_handle);
2753 return VPPCOM_EBADFD;
2755 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
2757 VDBG (0, "vep_sh (%u) is not a vep!", vep_handle);
2758 return VPPCOM_EINVAL;
2761 ASSERT (vep_session->vep.vep_sh == ~0);
2762 ASSERT (vep_session->vep.prev_sh == ~0);
2764 s = vcl_session_get_w_handle (wrk, session_handle);
2765 if (PREDICT_FALSE (!s))
2767 VDBG (0, "Invalid session_handle (%u)!", session_handle);
2768 return VPPCOM_EBADFD;
2770 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2772 VDBG (0, "session_handle (%u) is a vep!", vep_handle);
2773 return VPPCOM_EINVAL;
2779 if (PREDICT_FALSE (!event))
2781 VDBG (0, "EPOLL_CTL_ADD: NULL pointer to epoll_event structure!");
2782 return VPPCOM_EINVAL;
2784 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2786 VDBG (0, "EPOLL_CTL_ADD: %u already epolled!", s->session_index);
2790 if (vep_session->vep.next_sh != ~0)
2792 vcl_session_t *next_session;
2793 next_session = vcl_session_get_w_handle (wrk,
2794 vep_session->vep.next_sh);
2795 if (PREDICT_FALSE (!next_session))
2797 VDBG (0, "EPOLL_CTL_ADD: Invalid vep.next_sh (%u) on "
2798 "vep_idx (%u)!", vep_session->vep.next_sh, vep_handle);
2799 return VPPCOM_EBADFD;
2801 ASSERT (next_session->vep.prev_sh == vep_handle);
2802 next_session->vep.prev_sh = session_handle;
2804 s->vep.next_sh = vep_session->vep.next_sh;
2805 s->vep.prev_sh = vep_handle;
2806 s->vep.vep_sh = vep_handle;
2807 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2808 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
2810 s->flags &= ~VCL_SESSION_F_IS_VEP;
2811 s->flags |= VCL_SESSION_F_IS_VEP_SESSION;
2812 vep_session->vep.next_sh = session_handle;
2814 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2815 if (txf && (event->events & EPOLLOUT))
2816 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2818 /* Generate EPOLLOUT if tx fifo not full */
2819 if ((event->events & EPOLLOUT) && (vcl_session_write_ready (s) > 0))
2821 session_event_t e = { 0 };
2822 e.event_type = SESSION_IO_EVT_TX;
2823 e.session_index = s->session_index;
2824 vec_add1 (wrk->unhandled_evts_vector, e);
2827 /* Generate EPOLLIN if rx fifo has data */
2828 if ((event->events & EPOLLIN) && (vcl_session_read_ready (s) > 0))
2830 session_event_t e = { 0 };
2831 e.event_type = SESSION_IO_EVT_RX;
2832 e.session_index = s->session_index;
2833 vec_add1 (wrk->unhandled_evts_vector, e);
2834 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2837 if (!add_evt && vcl_session_is_closing (s))
2839 session_event_t e = { 0 };
2840 if (s->session_state == VCL_STATE_VPP_CLOSING)
2841 e.event_type = SESSION_CTRL_EVT_DISCONNECTED;
2843 e.event_type = SESSION_CTRL_EVT_RESET;
2844 e.session_index = s->session_index;
2846 vec_add1 (wrk->unhandled_evts_vector, e);
2848 VDBG (1, "EPOLL_CTL_ADD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2849 vep_handle, session_handle, event->events, event->data.u64);
2850 vcl_evt (VCL_EVT_EPOLL_CTLADD, s, event->events, event->data.u64);
2854 if (PREDICT_FALSE (!event))
2856 VDBG (0, "EPOLL_CTL_MOD: NULL pointer to epoll_event structure!");
2860 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2862 VDBG (0, "sh %u EPOLL_CTL_MOD: not a vep session!", session_handle);
2866 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2868 VDBG (0, "EPOLL_CTL_MOD: sh %u vep_sh (%u) != vep_sh (%u)!",
2869 session_handle, s->vep.vep_sh, vep_handle);
2874 /* Generate EPOLLOUT if session write ready nd event was not on */
2875 if ((event->events & EPOLLOUT) && !(s->vep.ev.events & EPOLLOUT) &&
2876 (vcl_session_write_ready (s) > 0))
2878 session_event_t e = { 0 };
2879 e.event_type = SESSION_IO_EVT_TX;
2880 e.session_index = s->session_index;
2881 vec_add1 (wrk->unhandled_evts_vector, e);
2883 /* Generate EPOLLIN if session read ready and event was not on */
2884 if ((event->events & EPOLLIN) && !(s->vep.ev.events & EPOLLIN) &&
2885 (vcl_session_read_ready (s) > 0))
2887 session_event_t e = { 0 };
2888 e.event_type = SESSION_IO_EVT_RX;
2889 e.session_index = s->session_index;
2890 vec_add1 (wrk->unhandled_evts_vector, e);
2891 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2893 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2895 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2898 if (event->events & EPOLLOUT)
2899 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2901 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2903 VDBG (1, "EPOLL_CTL_MOD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2904 vep_handle, session_handle, event->events, event->data.u64);
2908 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2910 VDBG (0, "EPOLL_CTL_DEL: %u not a vep session!", session_handle);
2914 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2916 VDBG (0, "EPOLL_CTL_DEL: sh %u vep_sh (%u) != vep_sh (%u)!",
2917 session_handle, s->vep.vep_sh, vep_handle);
2922 if (s->vep.prev_sh == vep_handle)
2923 vep_session->vep.next_sh = s->vep.next_sh;
2926 vcl_session_t *prev_session;
2927 prev_session = vcl_session_get_w_handle (wrk, s->vep.prev_sh);
2928 if (PREDICT_FALSE (!prev_session))
2930 VDBG (0, "EPOLL_CTL_DEL: Invalid prev_sh (%u) on sh (%u)!",
2931 s->vep.prev_sh, session_handle);
2932 return VPPCOM_EBADFD;
2934 ASSERT (prev_session->vep.next_sh == session_handle);
2935 prev_session->vep.next_sh = s->vep.next_sh;
2937 if (s->vep.next_sh != ~0)
2939 vcl_session_t *next_session;
2940 next_session = vcl_session_get_w_handle (wrk, s->vep.next_sh);
2941 if (PREDICT_FALSE (!next_session))
2943 VDBG (0, "EPOLL_CTL_DEL: Invalid next_sh (%u) on sh (%u)!",
2944 s->vep.next_sh, session_handle);
2945 return VPPCOM_EBADFD;
2947 ASSERT (next_session->vep.prev_sh == session_handle);
2948 next_session->vep.prev_sh = s->vep.prev_sh;
2951 if (s->vep.lt_next != VCL_INVALID_SESSION_INDEX)
2952 vcl_epoll_lt_del (wrk, s);
2954 memset (&s->vep, 0, sizeof (s->vep));
2955 s->vep.next_sh = ~0;
2956 s->vep.prev_sh = ~0;
2958 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
2959 s->flags &= ~VCL_SESSION_F_IS_VEP_SESSION;
2961 if (vcl_session_is_open (s))
2963 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2965 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2968 VDBG (1, "EPOLL_CTL_DEL: vep_idx %u, sh %u!", vep_handle,
2970 vcl_evt (VCL_EVT_EPOLL_CTLDEL, s, vep_sh);
2974 VDBG (0, "Invalid operation (%d)!", op);
2978 vep_verify_epoll_chain (wrk, vep_handle);
2985 vcl_epoll_wait_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2986 struct epoll_event *events, u32 * num_ev)
2988 session_disconnected_msg_t *disconnected_msg;
2989 session_connected_msg_t *connected_msg;
2990 u32 sid = ~0, session_events;
2991 u64 session_evt_data = ~0;
2995 switch (e->event_type)
2997 case SESSION_IO_EVT_RX:
2998 sid = e->session_index;
2999 s = vcl_session_get (wrk, sid);
3000 if (vcl_session_is_closed (s))
3002 vcl_fifo_rx_evt_valid_or_break (s);
3003 session_events = s->vep.ev.events;
3004 if (!(EPOLLIN & s->vep.ev.events) ||
3005 (s->flags & VCL_SESSION_F_HAS_RX_EVT) ||
3006 (s->vep.lt_next != VCL_INVALID_SESSION_INDEX))
3009 events[*num_ev].events = EPOLLIN;
3010 session_evt_data = s->vep.ev.data.u64;
3011 s->flags |= VCL_SESSION_F_HAS_RX_EVT;
3013 case SESSION_IO_EVT_TX:
3014 sid = e->session_index;
3015 s = vcl_session_get (wrk, sid);
3016 if (!s || !vcl_session_is_open (s))
3018 session_events = s->vep.ev.events;
3019 if (!(EPOLLOUT & session_events))
3022 events[*num_ev].events = EPOLLOUT;
3023 session_evt_data = s->vep.ev.data.u64;
3024 svm_fifo_reset_has_deq_ntf (vcl_session_is_ct (s) ?
3025 s->ct_tx_fifo : s->tx_fifo);
3027 case SESSION_CTRL_EVT_ACCEPTED:
3029 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
3031 s = vcl_session_get (wrk, e->session_index);
3034 session_events = s->vep.ev.events;
3035 sid = s->session_index;
3036 if (!(EPOLLIN & session_events) ||
3037 (s->vep.lt_next != VCL_INVALID_SESSION_INDEX))
3040 events[*num_ev].events = EPOLLIN;
3041 session_evt_data = s->vep.ev.data.u64;
3043 case SESSION_CTRL_EVT_CONNECTED:
3046 connected_msg = (session_connected_msg_t *) e->data;
3047 sid = vcl_session_connected_handler (wrk, connected_msg);
3050 sid = e->session_index;
3051 s = vcl_session_get (wrk, sid);
3052 if (vcl_session_is_closed (s))
3054 session_events = s->vep.ev.events;
3055 /* Generate EPOLLOUT because there's no connected event */
3056 if (!(EPOLLOUT & session_events))
3059 events[*num_ev].events = EPOLLOUT;
3060 session_evt_data = s->vep.ev.data.u64;
3061 if (s->session_state == VCL_STATE_DETACHED)
3062 events[*num_ev].events |= EPOLLHUP;
3064 case SESSION_CTRL_EVT_DISCONNECTED:
3067 disconnected_msg = (session_disconnected_msg_t *) e->data;
3068 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
3072 s = vcl_session_get (wrk, e->session_index);
3073 s->flags &= ~VCL_SESSION_F_PENDING_DISCONNECT;
3075 if (vcl_session_is_closed (s) ||
3076 !(s->flags & VCL_SESSION_F_IS_VEP_SESSION))
3078 if (s && (s->flags & VCL_SESSION_F_PENDING_FREE))
3079 vcl_session_free (wrk, s);
3082 sid = s->session_index;
3083 session_events = s->vep.ev.events;
3085 if (EPOLLRDHUP & session_events)
3087 /* If app can distinguish between RDHUP and HUP,
3088 * we make finer control */
3089 events[*num_ev].events = EPOLLRDHUP;
3090 if (s->flags & VCL_SESSION_F_WR_SHUTDOWN)
3092 events[*num_ev].events |= EPOLLHUP;
3097 events[*num_ev].events = EPOLLHUP;
3099 session_evt_data = s->vep.ev.data.u64;
3102 case SESSION_CTRL_EVT_RESET:
3106 vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
3107 s = vcl_session_get (wrk, sid);
3111 sid = e->session_index;
3112 s = vcl_session_get (wrk, sid);
3113 s->flags &= ~VCL_SESSION_F_PENDING_DISCONNECT;
3115 if (vcl_session_is_closed (s) ||
3116 !(s->flags & VCL_SESSION_F_IS_VEP_SESSION))
3118 if (s && (s->flags & VCL_SESSION_F_PENDING_FREE))
3119 vcl_session_free (wrk, s);
3122 session_events = s->vep.ev.events;
3124 events[*num_ev].events = EPOLLERR | EPOLLHUP;
3125 if ((EPOLLRDHUP & session_events) &&
3126 (s->flags & VCL_SESSION_F_RD_SHUTDOWN))
3128 events[*num_ev].events |= EPOLLRDHUP;
3130 if ((EPOLLIN & session_events) && (s->flags & VCL_SESSION_F_RD_SHUTDOWN))
3132 events[*num_ev].events |= EPOLLIN;
3134 session_evt_data = s->vep.ev.data.u64;
3136 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
3137 vcl_session_unlisten_reply_handler (wrk, e->data);
3139 case SESSION_CTRL_EVT_MIGRATED:
3140 vcl_session_migrated_handler (wrk, e->data);
3142 case SESSION_CTRL_EVT_CLEANUP:
3143 vcl_session_cleanup_handler (wrk, e->data);
3145 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
3146 vcl_session_req_worker_update_handler (wrk, e->data);
3148 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
3149 vcl_session_worker_update_reply_handler (wrk, e->data);
3151 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
3152 vcl_session_app_add_segment_handler (wrk, e->data);
3154 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
3155 vcl_session_app_del_segment_handler (wrk, e->data);
3157 case SESSION_CTRL_EVT_APP_WRK_RPC:
3158 vcl_worker_rpc_handler (wrk, e->data);
3161 VDBG (0, "unhandled: %u", e->event_type);
3167 events[*num_ev].data.u64 = session_evt_data;
3168 if (EPOLLONESHOT & session_events)
3170 s = vcl_session_get (wrk, sid);
3171 s->vep.ev.events = 0;
3173 else if (!(EPOLLET & session_events))
3175 s = vcl_session_get (wrk, sid);
3176 if (s->vep.lt_next == VCL_INVALID_SESSION_INDEX)
3177 vcl_epoll_lt_add (wrk, s);
3184 vcl_epoll_wait_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
3185 struct epoll_event *events, u32 maxevents,
3186 double wait_for_time, u32 * num_ev)
3188 svm_msg_q_msg_t *msg;
3192 if (vec_len (wrk->mq_msg_vector) && svm_msg_q_is_empty (mq))
3193 goto handle_dequeued;
3195 if (svm_msg_q_is_empty (mq))
3199 else if (wait_for_time < 0)
3200 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
3203 if (svm_msg_q_timedwait (mq, wait_for_time / 1e3))
3207 ASSERT (maxevents > *num_ev);
3208 vcl_mq_dequeue_batch (wrk, mq, ~0);
3211 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
3213 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
3214 e = svm_msg_q_msg_data (mq, msg);
3215 if (*num_ev < maxevents)
3216 vcl_epoll_wait_handle_mq_event (wrk, e, events, num_ev);
3218 vcl_handle_mq_event (wrk, e);
3219 svm_msg_q_free_msg (mq, msg);
3221 vec_reset_length (wrk->mq_msg_vector);
3222 vcl_handle_pending_wrk_updates (wrk);
3227 vppcom_epoll_wait_condvar (vcl_worker_t *wrk, struct epoll_event *events,
3228 int maxevents, u32 n_evts, double timeout_ms)
3235 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3240 vcl_epoll_wait_handle_mq (wrk, wrk->app_event_queue, events, maxevents,
3241 timeout_ms, &n_evts);
3242 if (n_evts || !timeout_ms)
3245 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3251 vppcom_epoll_wait_eventfd (vcl_worker_t *wrk, struct epoll_event *events,
3252 int maxevents, u32 n_evts, double timeout_ms)
3254 int __clib_unused n_read;
3255 vcl_mq_evt_conn_t *mqc;
3260 if (PREDICT_FALSE (wrk->api_client_handle == ~0))
3262 vcl_api_retry_attach (wrk);
3266 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
3270 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3275 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
3276 vec_len (wrk->mq_events), timeout_ms);
3279 VDBG (0, "epoll_wait error %u", errno);
3283 for (i = 0; i < n_mq_evts; i++)
3285 if (PREDICT_FALSE (wrk->mq_events[i].data.u32 == ~0))
3287 /* api socket was closed */
3288 vcl_api_handle_disconnect (wrk);
3292 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
3293 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
3294 vcl_epoll_wait_handle_mq (wrk, mqc->mq, events, maxevents, 0,
3298 if (n_evts || !timeout_ms)
3301 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3307 vcl_epoll_wait_handle_lt (vcl_worker_t *wrk, struct epoll_event *events,
3308 int maxevents, u32 *n_evts)
3310 u32 add_event = 0, next;
3315 ASSERT (wrk->ep_lt_current != VCL_INVALID_SESSION_INDEX);
3316 if (*n_evts >= maxevents)
3319 next = wrk->ep_lt_current;
3322 s = vcl_session_get (wrk, next);
3323 next = s->vep.lt_next;
3325 if ((s->vep.ev.events & EPOLLIN) && (rv = vcl_session_read_ready (s)))
3328 events[*n_evts].events |= rv > 0 ? EPOLLIN : EPOLLHUP | EPOLLRDHUP;
3329 evt_data = s->vep.ev.data.u64;
3331 if ((s->vep.ev.events & EPOLLOUT) && (rv = vcl_session_write_ready (s)))
3334 events[*n_evts].events |= rv > 0 ? EPOLLOUT : EPOLLHUP | EPOLLRDHUP;
3335 evt_data = s->vep.ev.data.u64;
3337 if (!add_event && s->session_state > VCL_STATE_READY)
3340 events[*n_evts].events |= EPOLLHUP | EPOLLRDHUP;
3341 evt_data = s->vep.ev.data.u64;
3345 events[*n_evts].data.u64 = evt_data;
3348 if (EPOLLONESHOT & s->vep.ev.events)
3349 s->vep.ev.events = 0;
3350 if (*n_evts == maxevents)
3352 wrk->ep_lt_current = next;
3358 vcl_epoll_lt_del (wrk, s);
3359 if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX)
3363 while (next != wrk->ep_lt_current);
3367 vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
3368 int maxevents, double wait_for_time)
3370 vcl_worker_t *wrk = vcl_worker_get_current ();
3371 vcl_session_t *vep_session;
3375 if (PREDICT_FALSE (maxevents <= 0))
3377 VDBG (0, "ERROR: Invalid maxevents (%d)!", maxevents);
3378 return VPPCOM_EINVAL;
3381 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
3383 return VPPCOM_EBADFD;
3385 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
3387 VDBG (0, "ERROR: vep_idx (%u) is not a vep!", vep_handle);
3388 return VPPCOM_EINVAL;
3391 if (vec_len (wrk->unhandled_evts_vector))
3393 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
3395 vcl_epoll_wait_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i],
3397 if (n_evts == maxevents)
3399 vec_delete (wrk->unhandled_evts_vector, i + 1, 0);
3403 vec_reset_length (wrk->unhandled_evts_vector);
3406 if (PREDICT_FALSE (wrk->ep_lt_current != VCL_INVALID_SESSION_INDEX))
3407 vcl_epoll_wait_handle_lt (wrk, events, maxevents, &n_evts);
3409 /* Request to only drain unhandled */
3410 if ((int) wait_for_time == -2)
3414 if (vcm->cfg.use_mq_eventfd)
3415 n_evts = vppcom_epoll_wait_eventfd (wrk, events, maxevents, n_evts,
3418 n_evts = vppcom_epoll_wait_condvar (wrk, events, maxevents, n_evts,
3425 vppcom_session_attr (uint32_t session_handle, uint32_t op,
3426 void *buffer, uint32_t * buflen)
3428 vcl_worker_t *wrk = vcl_worker_get_current ();
3429 u32 *flags = buffer;
3430 vppcom_endpt_t *ep = buffer;
3431 transport_endpt_attr_t tea;
3432 vcl_session_t *session;
3435 session = vcl_session_get_w_handle (wrk, session_handle);
3437 return VPPCOM_EBADFD;
3441 case VPPCOM_ATTR_GET_NREAD:
3442 rv = vcl_session_read_ready (session);
3443 VDBG (2, "VPPCOM_ATTR_GET_NREAD: sh %u, nread = %d", session_handle,
3447 case VPPCOM_ATTR_GET_NWRITE:
3448 rv = vcl_session_write_ready (session);
3449 VDBG (2, "VPPCOM_ATTR_GET_NWRITE: sh %u, nwrite = %d", session_handle,
3453 case VPPCOM_ATTR_GET_FLAGS:
3454 if (PREDICT_TRUE (buffer && buflen && (*buflen >= sizeof (*flags))))
3458 (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK) ?
3460 *buflen = sizeof (*flags);
3461 VDBG (2, "VPPCOM_ATTR_GET_FLAGS: sh %u, flags = 0x%08x, "
3462 "is_nonblocking = %u", session_handle, *flags,
3463 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3469 case VPPCOM_ATTR_SET_FLAGS:
3470 if (PREDICT_TRUE (buffer && buflen && (*buflen == sizeof (*flags))))
3472 if (*flags & O_NONBLOCK)
3473 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
3475 vcl_session_clear_attr (session, VCL_SESS_ATTR_NONBLOCK);
3477 VDBG (2, "VPPCOM_ATTR_SET_FLAGS: sh %u, flags = 0x%08x,"
3478 " is_nonblocking = %u", session_handle, *flags,
3479 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3485 case VPPCOM_ATTR_GET_PEER_ADDR:
3486 if (PREDICT_TRUE (buffer && buflen &&
3487 (*buflen >= sizeof (*ep)) && ep->ip))
3489 ep->is_ip4 = session->transport.is_ip4;
3490 ep->port = session->transport.rmt_port;
3491 if (session->transport.is_ip4)
3492 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
3493 sizeof (ip4_address_t));
3495 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
3496 sizeof (ip6_address_t));
3497 *buflen = sizeof (*ep);
3499 "VPPCOM_ATTR_GET_PEER_ADDR: sh %u, is_ip4 = %u, "
3500 "addr = %U, port %u",
3501 session_handle, ep->is_ip4, vcl_format_ip46_address,
3502 &session->transport.rmt_ip,
3503 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3504 clib_net_to_host_u16 (ep->port));
3510 case VPPCOM_ATTR_GET_LCL_ADDR:
3511 if (PREDICT_TRUE (buffer && buflen &&
3512 (*buflen >= sizeof (*ep)) && ep->ip))
3514 ep->is_ip4 = session->transport.is_ip4;
3515 ep->port = session->transport.lcl_port;
3516 if (session->transport.is_ip4)
3517 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip4,
3518 sizeof (ip4_address_t));
3520 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip6,
3521 sizeof (ip6_address_t));
3522 *buflen = sizeof (*ep);
3524 "VPPCOM_ATTR_GET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3526 session_handle, ep->is_ip4, vcl_format_ip46_address,
3527 &session->transport.lcl_ip,
3528 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3529 clib_net_to_host_u16 (ep->port));
3535 case VPPCOM_ATTR_SET_LCL_ADDR:
3536 if (PREDICT_TRUE (buffer && buflen &&
3537 (*buflen >= sizeof (*ep)) && ep->ip))
3539 session->transport.is_ip4 = ep->is_ip4;
3540 session->transport.lcl_port = ep->port;
3541 vcl_ip_copy_from_ep (&session->transport.lcl_ip, ep);
3542 *buflen = sizeof (*ep);
3544 "VPPCOM_ATTR_SET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3546 session_handle, ep->is_ip4, vcl_format_ip46_address,
3547 &session->transport.lcl_ip,
3548 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3549 clib_net_to_host_u16 (ep->port));
3555 case VPPCOM_ATTR_GET_LIBC_EPFD:
3556 rv = session->libc_epfd;
3557 VDBG (2, "VPPCOM_ATTR_GET_LIBC_EPFD: libc_epfd %d", rv);
3560 case VPPCOM_ATTR_SET_LIBC_EPFD:
3561 if (PREDICT_TRUE (buffer && buflen &&
3562 (*buflen == sizeof (session->libc_epfd))))
3564 session->libc_epfd = *(int *) buffer;
3565 *buflen = sizeof (session->libc_epfd);
3567 VDBG (2, "VPPCOM_ATTR_SET_LIBC_EPFD: libc_epfd %d, buflen %d",
3568 session->libc_epfd, *buflen);
3574 case VPPCOM_ATTR_GET_PROTOCOL:
3575 if (buffer && buflen && (*buflen >= sizeof (int)))
3577 *(int *) buffer = session->session_type;
3578 *buflen = sizeof (int);
3580 VDBG (2, "VPPCOM_ATTR_GET_PROTOCOL: %d (%s), buflen %d",
3581 *(int *) buffer, *(int *) buffer ? "UDP" : "TCP", *buflen);
3587 case VPPCOM_ATTR_GET_LISTEN:
3588 if (buffer && buflen && (*buflen >= sizeof (int)))
3590 *(int *) buffer = vcl_session_has_attr (session,
3591 VCL_SESS_ATTR_LISTEN);
3592 *buflen = sizeof (int);
3594 VDBG (2, "VPPCOM_ATTR_GET_LISTEN: %d, buflen %d", *(int *) buffer,
3601 case VPPCOM_ATTR_GET_ERROR:
3602 if (buffer && buflen && (*buflen >= sizeof (int)))
3604 *(int *) buffer = 0;
3605 *buflen = sizeof (int);
3607 VDBG (2, "VPPCOM_ATTR_GET_ERROR: %d, buflen %d, #VPP-TBD#",
3608 *(int *) buffer, *buflen);
3614 case VPPCOM_ATTR_GET_TX_FIFO_LEN:
3615 if (buffer && buflen && (*buflen >= sizeof (u32)))
3619 *(size_t *) buffer = (session->sndbuf_size ? session->sndbuf_size :
3621 svm_fifo_size (session->tx_fifo) :
3622 vcm->cfg.tx_fifo_size);
3623 *buflen = sizeof (u32);
3625 VDBG (2, "VPPCOM_ATTR_GET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3626 " #VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer,
3633 case VPPCOM_ATTR_SET_DSCP:
3634 if (buffer && buflen && (*buflen >= sizeof (u8)))
3636 session->dscp = *(u8 *) buffer;
3638 VDBG (2, "VPPCOM_ATTR_SET_DSCP: %u (0x%x), buflen %d,",
3639 *(u8 *) buffer, *(u8 *) buffer, *buflen);
3645 case VPPCOM_ATTR_SET_TX_FIFO_LEN:
3646 if (buffer && buflen && (*buflen == sizeof (u32)))
3649 session->sndbuf_size = *(u32 *) buffer;
3650 VDBG (2, "VPPCOM_ATTR_SET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3651 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3658 case VPPCOM_ATTR_GET_RX_FIFO_LEN:
3659 if (buffer && buflen && (*buflen >= sizeof (u32)))
3663 *(size_t *) buffer = (session->rcvbuf_size ? session->rcvbuf_size :
3665 svm_fifo_size (session->rx_fifo) :
3666 vcm->cfg.rx_fifo_size);
3667 *buflen = sizeof (u32);
3669 VDBG (2, "VPPCOM_ATTR_GET_RX_FIFO_LEN: %u (0x%x), buflen %d, "
3670 "#VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer, *buflen);
3676 case VPPCOM_ATTR_SET_RX_FIFO_LEN:
3677 if (buffer && buflen && (*buflen == sizeof (u32)))
3680 session->rcvbuf_size = *(u32 *) buffer;
3681 VDBG (2, "VPPCOM_ATTR_SET_RX_FIFO_LEN: %u (0x%x), buflen %d,"
3682 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3689 case VPPCOM_ATTR_GET_REUSEADDR:
3690 if (buffer && buflen && (*buflen >= sizeof (int)))
3693 *(int *) buffer = vcl_session_has_attr (session,
3694 VCL_SESS_ATTR_REUSEADDR);
3695 *buflen = sizeof (int);
3697 VDBG (2, "VPPCOM_ATTR_GET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3698 *(int *) buffer, *buflen);
3704 case VPPCOM_ATTR_SET_REUSEADDR:
3705 if (buffer && buflen && (*buflen == sizeof (int)) &&
3706 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3709 if (*(int *) buffer)
3710 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEADDR);
3712 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEADDR);
3714 VDBG (2, "VPPCOM_ATTR_SET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3715 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEADDR),
3722 case VPPCOM_ATTR_GET_REUSEPORT:
3723 if (buffer && buflen && (*buflen >= sizeof (int)))
3726 *(int *) buffer = vcl_session_has_attr (session,
3727 VCL_SESS_ATTR_REUSEPORT);
3728 *buflen = sizeof (int);
3730 VDBG (2, "VPPCOM_ATTR_GET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3731 *(int *) buffer, *buflen);
3737 case VPPCOM_ATTR_SET_REUSEPORT:
3738 if (buffer && buflen && (*buflen == sizeof (int)) &&
3739 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3742 if (*(int *) buffer)
3743 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEPORT);
3745 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEPORT);
3747 VDBG (2, "VPPCOM_ATTR_SET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3748 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEPORT),
3755 case VPPCOM_ATTR_GET_BROADCAST:
3756 if (buffer && buflen && (*buflen >= sizeof (int)))
3759 *(int *) buffer = vcl_session_has_attr (session,
3760 VCL_SESS_ATTR_BROADCAST);
3761 *buflen = sizeof (int);
3763 VDBG (2, "VPPCOM_ATTR_GET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3764 *(int *) buffer, *buflen);
3770 case VPPCOM_ATTR_SET_BROADCAST:
3771 if (buffer && buflen && (*buflen == sizeof (int)))
3774 if (*(int *) buffer)
3775 vcl_session_set_attr (session, VCL_SESS_ATTR_BROADCAST);
3777 vcl_session_clear_attr (session, VCL_SESS_ATTR_BROADCAST);
3779 VDBG (2, "VPPCOM_ATTR_SET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3780 vcl_session_has_attr (session, VCL_SESS_ATTR_BROADCAST),
3787 case VPPCOM_ATTR_GET_V6ONLY:
3788 if (buffer && buflen && (*buflen >= sizeof (int)))
3791 *(int *) buffer = vcl_session_has_attr (session,
3792 VCL_SESS_ATTR_V6ONLY);
3793 *buflen = sizeof (int);
3795 VDBG (2, "VPPCOM_ATTR_GET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3796 *(int *) buffer, *buflen);
3802 case VPPCOM_ATTR_SET_V6ONLY:
3803 if (buffer && buflen && (*buflen == sizeof (int)))
3806 if (*(int *) buffer)
3807 vcl_session_set_attr (session, VCL_SESS_ATTR_V6ONLY);
3809 vcl_session_clear_attr (session, VCL_SESS_ATTR_V6ONLY);
3811 VDBG (2, "VPPCOM_ATTR_SET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3812 vcl_session_has_attr (session, VCL_SESS_ATTR_V6ONLY),
3819 case VPPCOM_ATTR_GET_KEEPALIVE:
3820 if (buffer && buflen && (*buflen >= sizeof (int)))
3823 *(int *) buffer = vcl_session_has_attr (session,
3824 VCL_SESS_ATTR_KEEPALIVE);
3825 *buflen = sizeof (int);
3827 VDBG (2, "VPPCOM_ATTR_GET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3828 *(int *) buffer, *buflen);
3834 case VPPCOM_ATTR_SET_KEEPALIVE:
3835 if (buffer && buflen && (*buflen == sizeof (int)))
3838 if (*(int *) buffer)
3839 vcl_session_set_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3841 vcl_session_clear_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3843 VDBG (2, "VPPCOM_ATTR_SET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3844 vcl_session_has_attr (session, VCL_SESS_ATTR_KEEPALIVE),
3851 case VPPCOM_ATTR_GET_TCP_NODELAY:
3852 if (buffer && buflen && (*buflen >= sizeof (int)))
3855 *(int *) buffer = vcl_session_has_attr (session,
3856 VCL_SESS_ATTR_TCP_NODELAY);
3857 *buflen = sizeof (int);
3859 VDBG (2, "VPPCOM_ATTR_GET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3860 *(int *) buffer, *buflen);
3866 case VPPCOM_ATTR_SET_TCP_NODELAY:
3867 if (buffer && buflen && (*buflen == sizeof (int)))
3870 if (*(int *) buffer)
3871 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3873 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3875 VDBG (2, "VPPCOM_ATTR_SET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3876 vcl_session_has_attr (session, VCL_SESS_ATTR_TCP_NODELAY),
3883 case VPPCOM_ATTR_GET_TCP_KEEPIDLE:
3884 if (buffer && buflen && (*buflen >= sizeof (int)))
3887 *(int *) buffer = vcl_session_has_attr (session,
3888 VCL_SESS_ATTR_TCP_KEEPIDLE);
3889 *buflen = sizeof (int);
3891 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3892 *(int *) buffer, *buflen);
3898 case VPPCOM_ATTR_SET_TCP_KEEPIDLE:
3899 if (buffer && buflen && (*buflen == sizeof (int)))
3902 if (*(int *) buffer)
3903 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3905 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3907 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3908 vcl_session_has_attr (session,
3909 VCL_SESS_ATTR_TCP_KEEPIDLE), *buflen);
3915 case VPPCOM_ATTR_GET_TCP_KEEPINTVL:
3916 if (buffer && buflen && (*buflen >= sizeof (int)))
3919 *(int *) buffer = vcl_session_has_attr (session,
3920 VCL_SESS_ATTR_TCP_KEEPINTVL);
3921 *buflen = sizeof (int);
3923 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3924 *(int *) buffer, *buflen);
3930 case VPPCOM_ATTR_SET_TCP_KEEPINTVL:
3931 if (buffer && buflen && (*buflen == sizeof (int)))
3934 if (*(int *) buffer)
3935 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3937 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3939 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3940 vcl_session_has_attr (session,
3941 VCL_SESS_ATTR_TCP_KEEPINTVL), *buflen);
3947 case VPPCOM_ATTR_GET_TCP_USER_MSS:
3948 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
3954 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3955 tea.mss = *(u32 *) buffer;
3956 if (vcl_session_transport_attr (wrk, session, 1 /* is_get */, &tea))
3957 rv = VPPCOM_ENOPROTOOPT;
3961 *(u32 *) buffer = tea.mss;
3962 *buflen = sizeof (int);
3965 VDBG (2, "VPPCOM_ATTR_GET_TCP_USER_MSS: %d, buflen %d", *(int *) buffer,
3969 case VPPCOM_ATTR_SET_TCP_USER_MSS:
3970 if (!(buffer && buflen && (*buflen == sizeof (u32))))
3976 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3977 tea.mss = *(u32 *) buffer;
3978 if (vcl_session_transport_attr (wrk, session, 0 /* is_get */, &tea))
3979 rv = VPPCOM_ENOPROTOOPT;
3981 VDBG (2, "VPPCOM_ATTR_SET_TCP_USER_MSS: %u, buflen %d", tea.mss,
3985 case VPPCOM_ATTR_SET_CONNECTED:
3986 session->flags |= VCL_SESSION_F_CONNECTED;
3989 case VPPCOM_ATTR_SET_CKPAIR:
3990 if (!(buffer && buflen && (*buflen == sizeof (int))) ||
3991 !vcl_session_has_crypto (session))
3996 if (!session->ext_config)
3998 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_CRYPTO,
3999 sizeof (transport_endpt_ext_cfg_t));
4001 else if (session->ext_config->type != TRANSPORT_ENDPT_EXT_CFG_CRYPTO)
4007 session->ext_config->crypto.ckpair_index = *(uint32_t *) buffer;
4010 case VPPCOM_ATTR_SET_VRF:
4011 if (!(buffer && buflen && (*buflen == sizeof (u32))))
4016 session->vrf = *(u32 *) buffer;
4019 case VPPCOM_ATTR_GET_VRF:
4020 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
4025 *(u32 *) buffer = session->vrf;
4026 *buflen = sizeof (u32);
4029 case VPPCOM_ATTR_GET_DOMAIN:
4030 if (!(buffer && buflen && (*buflen >= sizeof (int))))
4036 if (session->transport.is_ip4)
4037 *(int *) buffer = AF_INET;
4039 *(int *) buffer = AF_INET6;
4040 *buflen = sizeof (int);
4042 VDBG (2, "VPPCOM_ATTR_GET_DOMAIN: %d, buflen %u", *(int *) buffer,
4046 case VPPCOM_ATTR_SET_ENDPT_EXT_CFG:
4047 if (!(buffer && buflen && (*buflen > 0)))
4052 if (session->ext_config)
4057 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_NONE,
4058 *buflen + sizeof (u32));
4059 clib_memcpy (session->ext_config->data, buffer, *buflen);
4060 session->ext_config->len = *buflen;
4072 vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
4073 uint32_t buflen, int flags, vppcom_endpt_t * ep)
4075 vcl_worker_t *wrk = vcl_worker_get_current ();
4076 vcl_session_t *session;
4080 rv = vppcom_session_read (session_handle, buffer, buflen);
4081 else if (flags & MSG_PEEK)
4082 rv = vppcom_session_peek (session_handle, buffer, buflen);
4085 VDBG (0, "Unsupport flags for recvfrom %d", flags);
4086 return VPPCOM_EAFNOSUPPORT;
4091 session = vcl_session_get_w_handle (wrk, session_handle);
4092 if (session->transport.is_ip4)
4093 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
4094 sizeof (ip4_address_t));
4096 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
4097 sizeof (ip6_address_t));
4098 ep->is_ip4 = session->transport.is_ip4;
4099 ep->port = session->transport.rmt_port;
4106 vppcom_session_sendto (uint32_t session_handle, void *buffer,
4107 uint32_t buflen, int flags, vppcom_endpt_t * ep)
4109 vcl_worker_t *wrk = vcl_worker_get_current ();
4112 s = vcl_session_get_w_handle (wrk, session_handle);
4113 if (PREDICT_FALSE (!s))
4114 return VPPCOM_EBADFD;
4118 if (!vcl_session_is_cl (s))
4119 return VPPCOM_EINVAL;
4121 s->transport.is_ip4 = ep->is_ip4;
4122 s->transport.rmt_port = ep->port;
4123 vcl_ip_copy_from_ep (&s->transport.rmt_ip, ep);
4125 /* Session not connected/bound in vpp. Create it by 'connecting' it */
4126 if (PREDICT_FALSE (s->session_state == VCL_STATE_CLOSED))
4128 u32 session_index = s->session_index;
4129 f64 timeout = vcm->cfg.session_timeout;
4132 vcl_send_session_connect (wrk, s);
4133 rv = vppcom_wait_for_session_state_change (session_index,
4138 s = vcl_session_get (wrk, session_index);
4144 // TBD check the flags and do the right thing
4145 VDBG (2, "handling flags 0x%u (%d) not implemented yet.", flags, flags);
4148 return (vppcom_session_write_inline (wrk, s, buffer, buflen, 1,
4149 s->is_dgram ? 1 : 0));
4153 vppcom_poll (vcl_poll_t * vp, uint32_t n_sids, double wait_for_time)
4155 vcl_worker_t *wrk = vcl_worker_get_current ();
4156 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
4157 u32 i, keep_trying = 1;
4158 svm_msg_q_msg_t msg;
4162 VDBG (3, "vp %p, nsids %u, wait_for_time %f", vp, n_sids, wait_for_time);
4165 return VPPCOM_EFAULT;
4169 vcl_session_t *session;
4171 /* Dequeue all events and drop all unhandled io events */
4172 while (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0) == 0)
4174 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
4175 vcl_handle_mq_event (wrk, e);
4176 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
4178 vec_reset_length (wrk->unhandled_evts_vector);
4180 for (i = 0; i < n_sids; i++)
4182 session = vcl_session_get (wrk, vp[i].sh);
4185 vp[i].revents = POLLHUP;
4192 if (POLLIN & vp[i].events)
4194 rv = vcl_session_read_ready (session);
4197 vp[i].revents |= POLLIN;
4204 case VPPCOM_ECONNRESET:
4205 vp[i].revents = POLLHUP;
4209 vp[i].revents = POLLERR;
4216 if (POLLOUT & vp[i].events)
4218 rv = vcl_session_write_ready (session);
4221 vp[i].revents |= POLLOUT;
4228 case VPPCOM_ECONNRESET:
4229 vp[i].revents = POLLHUP;
4233 vp[i].revents = POLLERR;
4240 if (0) // Note "done:" label used by VCL_SESSION_LOCK_AND_GET()
4242 vp[i].revents = POLLNVAL;
4246 if (wait_for_time != -1)
4247 keep_trying = (clib_time_now (&wrk->clib_time) <= timeout) ? 1 : 0;
4249 while ((num_ev == 0) && keep_trying);
4255 vppcom_mq_epoll_fd (void)
4257 vcl_worker_t *wrk = vcl_worker_get_current ();
4258 return wrk->mqs_epfd;
4262 vppcom_session_index (vcl_session_handle_t session_handle)
4264 return session_handle & 0xFFFFFF;
4268 vppcom_session_worker (vcl_session_handle_t session_handle)
4270 return session_handle >> 24;
4274 vppcom_worker_register (void)
4276 if (!vcl_worker_alloc_and_init ())
4277 return VPPCOM_EEXIST;
4279 if (vcl_worker_register_with_vpp ())
4280 return VPPCOM_EEXIST;
4286 vppcom_worker_unregister (void)
4288 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
4289 vcl_set_worker_index (~0);
4293 vppcom_worker_index_set (int index)
4295 vcl_set_worker_index (index);
4299 vppcom_worker_index (void)
4301 return vcl_get_worker_index ();
4305 vppcom_worker_mqs_epfd (void)
4307 vcl_worker_t *wrk = vcl_worker_get_current ();
4308 if (!vcm->cfg.use_mq_eventfd)
4310 return wrk->mqs_epfd;
4314 vppcom_session_is_connectable_listener (uint32_t session_handle)
4316 vcl_session_t *session;
4317 vcl_worker_t *wrk = vcl_worker_get_current ();
4318 session = vcl_session_get_w_handle (wrk, session_handle);
4320 return VPPCOM_EBADFD;
4321 return vcl_session_is_connectable_listener (wrk, session);
4325 vppcom_session_listener (uint32_t session_handle)
4327 vcl_worker_t *wrk = vcl_worker_get_current ();
4328 vcl_session_t *listen_session, *session;
4329 session = vcl_session_get_w_handle (wrk, session_handle);
4331 return VPPCOM_EBADFD;
4332 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
4333 return VPPCOM_EBADFD;
4334 listen_session = vcl_session_get_w_handle (wrk, session->listener_index);
4335 if (!listen_session)
4336 return VPPCOM_EBADFD;
4337 return vcl_session_handle (listen_session);
4341 vppcom_session_n_accepted (uint32_t session_handle)
4343 vcl_worker_t *wrk = vcl_worker_get_current ();
4344 vcl_session_t *session = vcl_session_get_w_handle (wrk, session_handle);
4346 return VPPCOM_EBADFD;
4347 return session->n_accepted_sessions;
4351 vppcom_proto_str (vppcom_proto_t proto)
4353 char const *proto_str;
4357 case VPPCOM_PROTO_TCP:
4360 case VPPCOM_PROTO_UDP:
4363 case VPPCOM_PROTO_TLS:
4366 case VPPCOM_PROTO_QUIC:
4369 case VPPCOM_PROTO_DTLS:
4372 case VPPCOM_PROTO_SRTP:
4376 proto_str = "UNKNOWN";
4383 vppcom_retval_str (int retval)
4394 st = "VPPCOM_EAGAIN";
4398 st = "VPPCOM_EFAULT";
4402 st = "VPPCOM_ENOMEM";
4406 st = "VPPCOM_EINVAL";
4410 st = "VPPCOM_EBADFD";
4413 case VPPCOM_EAFNOSUPPORT:
4414 st = "VPPCOM_EAFNOSUPPORT";
4417 case VPPCOM_ECONNABORTED:
4418 st = "VPPCOM_ECONNABORTED";
4421 case VPPCOM_ECONNRESET:
4422 st = "VPPCOM_ECONNRESET";
4425 case VPPCOM_ENOTCONN:
4426 st = "VPPCOM_ENOTCONN";
4429 case VPPCOM_ECONNREFUSED:
4430 st = "VPPCOM_ECONNREFUSED";
4433 case VPPCOM_ETIMEDOUT:
4434 st = "VPPCOM_ETIMEDOUT";
4437 case VPPCOM_EADDRINUSE:
4438 st = "VPPCOM_EADDRINUSE";
4442 st = "UNKNOWN_STATE";
4450 vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
4452 if (vcm->cfg.vpp_app_socket_api)
4453 return vcl_sapi_add_cert_key_pair (ckpair);
4455 return vcl_bapi_add_cert_key_pair (ckpair);
4459 vppcom_del_cert_key_pair (uint32_t ckpair_index)
4461 if (vcm->cfg.vpp_app_socket_api)
4462 return vcl_sapi_del_cert_key_pair (ckpair_index);
4464 return vcl_bapi_del_cert_key_pair (ckpair_index);
4468 vppcom_session_get_error (uint32_t session_handle)
4470 vcl_worker_t *wrk = vcl_worker_get_current ();
4471 vcl_session_t *session = 0;
4473 session = vcl_session_get_w_handle (wrk, session_handle);
4475 return VPPCOM_EBADFD;
4477 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
4479 VWRN ("epoll session %u! will not have connect", session->session_index);
4480 return VPPCOM_EBADFD;
4483 if (session->vpp_error == SESSION_E_PORTINUSE)
4484 return VPPCOM_EADDRINUSE;
4485 else if (session->vpp_error == SESSION_E_REFUSED)
4486 return VPPCOM_ECONNREFUSED;
4487 else if (session->vpp_error != SESSION_E_NONE)
4488 return VPPCOM_EFAULT;
4494 * fd.io coding-style-patch-verification: ON
4497 * eval: (c-set-style "gnu")