2 * Copyright (c) 2017-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 #include <vcl/vppcom.h>
19 #include <vcl/vcl_debug.h>
20 #include <vcl/vcl_private.h>
21 #include <svm/fifo_segment.h>
23 __thread uword __vcl_worker_index = ~0;
26 vcl_mq_dequeue_batch (vcl_worker_t * wrk, svm_msg_q_t * mq, u32 n_max_msg)
28 u32 n_msgs = 0, sz, len;
30 while ((sz = svm_msg_q_size (mq)))
32 len = vec_len (wrk->mq_msg_vector);
33 vec_validate (wrk->mq_msg_vector, len + sz - 1);
34 svm_msg_q_sub_raw_batch (mq, wrk->mq_msg_vector + len, sz);
43 vcl_msg_add_ext_config (vcl_session_t *s, uword *offset)
47 c = vcl_segment_alloc_chunk (vcl_vpp_worker_segment_handle (0),
48 0 /* one slice only */, s->ext_config->len,
51 clib_memcpy_fast (c->data, s->ext_config, s->ext_config->len);
55 vcl_send_session_listen (vcl_worker_t * wrk, vcl_session_t * s)
57 app_session_evt_t _app_evt, *app_evt = &_app_evt;
58 session_listen_msg_t *mp;
61 mq = vcl_worker_ctrl_mq (wrk);
62 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_LISTEN);
63 mp = (session_listen_msg_t *) app_evt->evt->data;
64 memset (mp, 0, sizeof (*mp));
65 mp->client_index = wrk->api_client_handle;
66 mp->context = s->session_index;
67 mp->wrk_index = wrk->vpp_wrk_index;
68 mp->is_ip4 = s->transport.is_ip4;
69 clib_memcpy_fast (&mp->ip, &s->transport.lcl_ip, sizeof (mp->ip));
70 mp->port = s->transport.lcl_port;
71 mp->proto = s->session_type;
73 if (s->flags & VCL_SESSION_F_CONNECTED)
74 mp->flags = TRANSPORT_CFG_F_CONNECTED;
76 vcl_msg_add_ext_config (s, &mp->ext_config);
77 app_send_ctrl_evt_to_vpp (mq, app_evt);
80 clib_mem_free (s->ext_config);
86 vcl_send_session_connect (vcl_worker_t * wrk, vcl_session_t * s)
88 app_session_evt_t _app_evt, *app_evt = &_app_evt;
89 session_connect_msg_t *mp;
92 mq = vcl_worker_ctrl_mq (wrk);
93 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_CONNECT);
94 mp = (session_connect_msg_t *) app_evt->evt->data;
95 memset (mp, 0, sizeof (*mp));
96 mp->client_index = wrk->api_client_handle;
97 mp->context = s->session_index;
99 mp->wrk_index = wrk->vpp_wrk_index;
100 mp->is_ip4 = s->transport.is_ip4;
101 mp->parent_handle = s->parent_handle;
102 clib_memcpy_fast (&mp->ip, &s->transport.rmt_ip, sizeof (mp->ip));
103 clib_memcpy_fast (&mp->lcl_ip, &s->transport.lcl_ip, sizeof (mp->lcl_ip));
104 mp->port = s->transport.rmt_port;
105 mp->lcl_port = s->transport.lcl_port;
106 mp->proto = s->session_type;
108 if (s->flags & VCL_SESSION_F_CONNECTED)
109 mp->flags |= TRANSPORT_CFG_F_CONNECTED;
111 vcl_msg_add_ext_config (s, &mp->ext_config);
112 app_send_ctrl_evt_to_vpp (mq, app_evt);
116 clib_mem_free (s->ext_config);
122 vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s)
124 app_session_evt_t _app_evt, *app_evt = &_app_evt;
125 session_unlisten_msg_t *mp;
128 mq = vcl_worker_ctrl_mq (wrk);
129 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_UNLISTEN);
130 mp = (session_unlisten_msg_t *) app_evt->evt->data;
131 memset (mp, 0, sizeof (*mp));
132 mp->client_index = wrk->api_client_handle;
133 mp->wrk_index = wrk->vpp_wrk_index;
134 mp->handle = s->vpp_handle;
135 mp->context = wrk->wrk_index;
136 app_send_ctrl_evt_to_vpp (mq, app_evt);
140 vcl_send_session_shutdown (vcl_worker_t *wrk, vcl_session_t *s)
142 app_session_evt_t _app_evt, *app_evt = &_app_evt;
143 session_shutdown_msg_t *mp;
146 /* Send to thread that owns the session */
148 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_SHUTDOWN);
149 mp = (session_shutdown_msg_t *) app_evt->evt->data;
150 memset (mp, 0, sizeof (*mp));
151 mp->client_index = wrk->api_client_handle;
152 mp->handle = s->vpp_handle;
153 app_send_ctrl_evt_to_vpp (mq, app_evt);
157 vcl_send_session_disconnect (vcl_worker_t * wrk, vcl_session_t * s)
159 app_session_evt_t _app_evt, *app_evt = &_app_evt;
160 session_disconnect_msg_t *mp;
163 /* Send to thread that owns the session */
165 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_DISCONNECT);
166 mp = (session_disconnect_msg_t *) app_evt->evt->data;
167 memset (mp, 0, sizeof (*mp));
168 mp->client_index = wrk->api_client_handle;
169 mp->handle = s->vpp_handle;
170 app_send_ctrl_evt_to_vpp (mq, app_evt);
174 vcl_send_app_detach (vcl_worker_t * wrk)
176 app_session_evt_t _app_evt, *app_evt = &_app_evt;
177 session_app_detach_msg_t *mp;
180 mq = vcl_worker_ctrl_mq (wrk);
181 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_DETACH);
182 mp = (session_app_detach_msg_t *) app_evt->evt->data;
183 memset (mp, 0, sizeof (*mp));
184 mp->client_index = wrk->api_client_handle;
185 app_send_ctrl_evt_to_vpp (mq, app_evt);
189 vcl_send_session_accepted_reply (svm_msg_q_t * mq, u32 context,
190 session_handle_t handle, int retval)
192 app_session_evt_t _app_evt, *app_evt = &_app_evt;
193 session_accepted_reply_msg_t *rmp;
194 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_ACCEPTED_REPLY);
195 rmp = (session_accepted_reply_msg_t *) app_evt->evt->data;
196 rmp->handle = handle;
197 rmp->context = context;
198 rmp->retval = retval;
199 app_send_ctrl_evt_to_vpp (mq, app_evt);
203 vcl_send_session_disconnected_reply (vcl_worker_t * wrk, vcl_session_t * s,
206 app_session_evt_t _app_evt, *app_evt = &_app_evt;
207 session_disconnected_reply_msg_t *rmp;
208 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
209 SESSION_CTRL_EVT_DISCONNECTED_REPLY);
210 rmp = (session_disconnected_reply_msg_t *) app_evt->evt->data;
211 rmp->handle = s->vpp_handle;
212 rmp->context = wrk->api_client_handle;
213 rmp->retval = retval;
214 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
218 vcl_send_session_reset_reply (vcl_worker_t * wrk, vcl_session_t * s,
221 app_session_evt_t _app_evt, *app_evt = &_app_evt;
222 session_reset_reply_msg_t *rmp;
223 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
224 SESSION_CTRL_EVT_RESET_REPLY);
225 rmp = (session_reset_reply_msg_t *) app_evt->evt->data;
226 rmp->handle = s->vpp_handle;
227 rmp->context = wrk->api_client_handle;
228 rmp->retval = retval;
229 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
233 vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
236 app_session_evt_t _app_evt, *app_evt = &_app_evt;
237 session_worker_update_msg_t *mp;
239 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
240 SESSION_CTRL_EVT_WORKER_UPDATE);
241 mp = (session_worker_update_msg_t *) app_evt->evt->data;
242 mp->client_index = wrk->api_client_handle;
243 mp->handle = s->vpp_handle;
244 mp->req_wrk_index = wrk->vpp_wrk_index;
245 mp->wrk_index = wrk_index;
246 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
250 vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len)
252 app_session_evt_t _app_evt, *app_evt = &_app_evt;
253 session_app_wrk_rpc_msg_t *mp;
254 vcl_worker_t *dst_wrk, *wrk;
258 if (data_len > sizeof (mp->data))
261 clib_spinlock_lock (&vcm->workers_lock);
263 dst_wrk = vcl_worker_get_if_valid (dst_wrk_index);
267 wrk = vcl_worker_get_current ();
268 mq = vcl_worker_ctrl_mq (wrk);
269 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_WRK_RPC);
270 mp = (session_app_wrk_rpc_msg_t *) app_evt->evt->data;
271 mp->client_index = wrk->api_client_handle;
272 mp->wrk_index = dst_wrk->vpp_wrk_index;
273 clib_memcpy (mp->data, data, data_len);
274 app_send_ctrl_evt_to_vpp (mq, app_evt);
278 clib_spinlock_unlock (&vcm->workers_lock);
283 vcl_session_transport_attr (vcl_worker_t *wrk, vcl_session_t *s, u8 is_get,
284 transport_endpt_attr_t *attr)
286 app_session_evt_t _app_evt, *app_evt = &_app_evt;
287 session_transport_attr_msg_t *mp;
291 ASSERT (!wrk->session_attr_op);
292 wrk->session_attr_op = 1;
293 wrk->session_attr_op_rv = -1;
296 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_TRANSPORT_ATTR);
297 mp = (session_transport_attr_msg_t *) app_evt->evt->data;
298 memset (mp, 0, sizeof (*mp));
299 mp->client_index = wrk->api_client_handle;
300 mp->handle = s->vpp_handle;
303 app_send_ctrl_evt_to_vpp (mq, app_evt);
305 timeout = clib_time_now (&wrk->clib_time) + 1;
307 while (wrk->session_attr_op && clib_time_now (&wrk->clib_time) < timeout)
308 vcl_flush_mq_events ();
310 if (!wrk->session_attr_op_rv && is_get)
311 *attr = wrk->session_attr_rv;
313 wrk->session_attr_op = 0;
315 return wrk->session_attr_op_rv;
319 vcl_session_accepted_handler (vcl_worker_t * wrk, session_accepted_msg_t * mp,
322 vcl_session_t *session, *listen_session;
325 session = vcl_session_alloc (wrk);
327 listen_session = vcl_session_get (wrk, ls_index);
328 if (listen_session->vpp_handle != mp->listener_handle)
330 VDBG (0, "ERROR: listener handle %lu does not match session %u",
331 mp->listener_handle, ls_index);
335 if (vcl_segment_attach_session (
336 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
337 mp->vpp_event_queue_address, mp->mq_index, 0, session))
339 VDBG (0, "session %u [0x%llx]: failed to attach fifos",
340 session->session_index, mp->handle);
344 session->vpp_handle = mp->handle;
345 session->session_state = VCL_STATE_READY;
346 session->transport.rmt_port = mp->rmt.port;
347 session->transport.is_ip4 = mp->rmt.is_ip4;
348 clib_memcpy_fast (&session->transport.rmt_ip, &mp->rmt.ip,
349 sizeof (ip46_address_t));
351 vcl_session_table_add_vpp_handle (wrk, mp->handle, session->session_index);
352 session->transport.lcl_port = mp->lcl.port;
353 session->transport.lcl_ip = mp->lcl.ip;
354 session->session_type = listen_session->session_type;
355 session->is_dgram = vcl_proto_is_dgram (session->session_type);
356 session->listener_index = listen_session->session_index;
357 listen_session->n_accepted_sessions++;
359 vcl_evt (VCL_EVT_ACCEPT, session, listen_session, session_index);
361 vcl_send_session_accepted_reply (session->vpp_evt_q, mp->context,
362 session->vpp_handle, 0);
364 return session->session_index;
367 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0),
368 mp->vpp_event_queue_address, mp->mq_index, &evt_q);
369 vcl_send_session_accepted_reply (evt_q, mp->context, mp->handle,
370 VNET_API_ERROR_INVALID_ARGUMENT);
371 vcl_session_free (wrk, session);
372 return VCL_INVALID_SESSION_INDEX;
376 vcl_session_connected_handler (vcl_worker_t * wrk,
377 session_connected_msg_t * mp)
379 vcl_session_t *session = 0;
382 session_index = mp->context;
383 session = vcl_session_get (wrk, session_index);
384 if (PREDICT_FALSE (!session))
386 VERR ("vpp handle 0x%llx has no session index (%u)!", mp->handle,
388 /* Should not happen but if it does, force vpp session cleanup */
389 vcl_session_t tmp_session = {
390 .vpp_handle = mp->handle,
393 vcl_segment_attach_session (
394 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
395 mp->vpp_event_queue_address, mp->mq_index, 0, session);
396 if (tmp_session.vpp_evt_q)
397 vcl_send_session_disconnect (wrk, &tmp_session);
398 return VCL_INVALID_SESSION_INDEX;
403 VDBG (0, "session %u: connect failed! %U", session_index,
404 format_session_error, mp->retval);
405 session->session_state = VCL_STATE_DETACHED;
406 session->vpp_handle = VCL_INVALID_SESSION_HANDLE;
407 return session_index;
410 session->vpp_handle = mp->handle;
412 /* Add to lookup table. Even if something fails, session cannot be
413 * cleaned up prior to notifying vpp and going through the cleanup
414 * "procedure" see @ref vcl_session_cleanup_handler */
415 vcl_session_table_add_vpp_handle (wrk, mp->handle, session_index);
417 if (vcl_segment_attach_session (
418 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
419 mp->vpp_event_queue_address, mp->mq_index, 0, session))
421 VDBG (0, "session %u [0x%llx]: failed to attach fifos",
422 session->session_index, session->vpp_handle);
423 session->session_state = VCL_STATE_UPDATED;
424 vcl_send_session_disconnect (wrk, session);
425 return session_index;
430 if (vcl_segment_attach_session (mp->ct_segment_handle, mp->ct_rx_fifo,
431 mp->ct_tx_fifo, (uword) ~0, ~0, 1,
434 VDBG (0, "session %u [0x%llx]: failed to attach ct fifos",
435 session->session_index, session->vpp_handle);
436 session->session_state = VCL_STATE_UPDATED;
437 vcl_send_session_disconnect (wrk, session);
438 return session_index;
442 session->transport.is_ip4 = mp->lcl.is_ip4;
443 clib_memcpy_fast (&session->transport.lcl_ip, &mp->lcl.ip,
444 sizeof (session->transport.lcl_ip));
445 session->transport.lcl_port = mp->lcl.port;
447 /* Application closed session before connect reply */
448 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK)
449 && session->session_state == VCL_STATE_CLOSED)
450 vcl_send_session_disconnect (wrk, session);
452 session->session_state = VCL_STATE_READY;
454 VDBG (0, "session %u [0x%llx] connected local: %U:%u remote %U:%u",
455 session->session_index, session->vpp_handle, vcl_format_ip46_address,
456 &session->transport.lcl_ip,
457 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
458 clib_net_to_host_u16 (session->transport.lcl_port),
459 vcl_format_ip46_address, &session->transport.rmt_ip,
460 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
461 clib_net_to_host_u16 (session->transport.rmt_port));
463 return session_index;
467 vcl_flag_accepted_session (vcl_session_t * session, u64 handle, u32 flags)
469 vcl_session_msg_t *accepted_msg;
472 for (i = 0; i < vec_len (session->accept_evts_fifo); i++)
474 accepted_msg = &session->accept_evts_fifo[i];
475 if (accepted_msg->accepted_msg.handle == handle)
477 accepted_msg->flags |= flags;
485 vcl_session_reset_handler (vcl_worker_t * wrk,
486 session_reset_msg_t * reset_msg)
488 vcl_session_t *session;
491 sid = vcl_session_index_from_vpp_handle (wrk, reset_msg->handle);
492 session = vcl_session_get (wrk, sid);
495 VDBG (0, "request to reset unknown handle 0x%llx", reset_msg->handle);
496 return VCL_INVALID_SESSION_INDEX;
499 /* Caught a reset before actually accepting the session */
500 if (session->session_state == VCL_STATE_LISTEN)
503 if (!vcl_flag_accepted_session (session, reset_msg->handle,
504 VCL_ACCEPTED_F_RESET))
505 VDBG (0, "session was not accepted!");
506 return VCL_INVALID_SESSION_INDEX;
509 if (session->session_state != VCL_STATE_CLOSED)
510 session->session_state = VCL_STATE_DISCONNECT;
511 VDBG (0, "session %u [0x%llx]: reset", sid, reset_msg->handle);
516 vcl_session_bound_handler (vcl_worker_t * wrk, session_bound_msg_t * mp)
518 vcl_session_t *session;
519 u32 sid = mp->context;
521 session = vcl_session_get (wrk, sid);
524 VERR ("session %u [0x%llx]: bind failed: %U", sid, mp->handle,
525 format_session_error, mp->retval);
528 session->session_state = VCL_STATE_DETACHED;
529 session->vpp_handle = mp->handle;
534 VDBG (0, "session %u [0x%llx]: Invalid session index!", sid,
536 return VCL_INVALID_SESSION_INDEX;
540 session->vpp_handle = mp->handle;
541 session->transport.is_ip4 = mp->lcl_is_ip4;
542 clib_memcpy_fast (&session->transport.lcl_ip, mp->lcl_ip,
543 sizeof (ip46_address_t));
544 session->transport.lcl_port = mp->lcl_port;
545 vcl_session_table_add_listener (wrk, mp->handle, sid);
546 session->session_state = VCL_STATE_LISTEN;
548 if (vcl_session_is_cl (session))
550 if (vcl_segment_attach_session (mp->segment_handle, mp->rx_fifo,
551 mp->tx_fifo, mp->vpp_evt_q, mp->mq_index,
554 VDBG (0, "session %u [0x%llx]: failed to attach fifos",
555 session->session_index, session->vpp_handle);
556 session->session_state = VCL_STATE_DETACHED;
557 return VCL_INVALID_SESSION_INDEX;
561 VDBG (0, "session %u [0x%llx]: listen succeeded!", sid, mp->handle);
566 vcl_session_unlisten_reply_handler (vcl_worker_t * wrk, void *data)
568 session_unlisten_reply_msg_t *mp = (session_unlisten_reply_msg_t *) data;
571 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
574 VDBG (0, "Unlisten reply with wrong handle %llx", mp->handle);
577 if (s->session_state != VCL_STATE_DISCONNECT)
579 /* Connected udp listener */
580 if (s->session_type == VPPCOM_PROTO_UDP
581 && s->session_state == VCL_STATE_CLOSED)
584 VDBG (0, "Unlisten session in wrong state %llx", mp->handle);
589 VDBG (0, "ERROR: session %u [0xllx]: unlisten failed: %U",
590 s->session_index, mp->handle, format_session_error, mp->retval);
592 if (mp->context != wrk->wrk_index)
593 VDBG (0, "wrong context");
595 vcl_session_table_del_vpp_handle (wrk, mp->handle);
596 vcl_session_free (wrk, s);
600 vcl_session_migrated_handler (vcl_worker_t * wrk, void *data)
602 session_migrated_msg_t *mp = (session_migrated_msg_t *) data;
606 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
609 VDBG (0, "Migrated notification with wrong handle %llx", mp->handle);
613 /* Only validate if a value is provided */
614 if (mp->segment_handle != SESSION_INVALID_HANDLE)
616 fs_index = vcl_segment_table_lookup (mp->segment_handle);
617 if (fs_index == VCL_INVALID_SEGMENT_INDEX)
619 VDBG (0, "segment %lx for session %u is not mounted!",
620 mp->segment_handle, s->session_index);
621 s->session_state = VCL_STATE_DETACHED;
626 s->vpp_handle = mp->new_handle;
628 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0), mp->vpp_evt_q,
629 mp->vpp_thread_index, &s->vpp_evt_q);
631 vcl_session_table_del_vpp_handle (wrk, mp->handle);
632 vcl_session_table_add_vpp_handle (wrk, mp->new_handle, s->session_index);
634 /* Generate new tx event if we have outstanding data */
635 if (svm_fifo_has_event (s->tx_fifo))
636 app_send_io_evt_to_vpp (s->vpp_evt_q,
637 s->tx_fifo->shr->master_session_index,
638 SESSION_IO_EVT_TX, SVM_Q_WAIT);
640 VDBG (0, "Migrated 0x%lx to thread %u 0x%lx", mp->handle,
641 mp->vpp_thread_index, mp->new_handle);
644 static vcl_session_t *
645 vcl_session_accepted (vcl_worker_t * wrk, session_accepted_msg_t * msg)
647 vcl_session_msg_t *vcl_msg;
648 vcl_session_t *session;
650 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
651 if (PREDICT_FALSE (session != 0))
652 VWRN ("session overlap handle %lu state %u!", msg->handle,
653 session->session_state);
655 session = vcl_session_table_lookup_listener (wrk, msg->listener_handle);
658 VERR ("couldn't find listen session: listener handle %llx",
659 msg->listener_handle);
663 clib_fifo_add2 (session->accept_evts_fifo, vcl_msg);
665 vcl_msg->accepted_msg = *msg;
666 /* Session handle points to listener until fully accepted by app */
667 vcl_session_table_add_vpp_handle (wrk, msg->handle, session->session_index);
672 static vcl_session_t *
673 vcl_session_disconnected_handler (vcl_worker_t * wrk,
674 session_disconnected_msg_t * msg)
676 vcl_session_t *session;
678 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
681 VWRN ("request to disconnect unknown handle 0x%llx", msg->handle);
685 /* Late disconnect notification on a session that has been closed */
686 if (session->session_state == VCL_STATE_CLOSED)
689 /* Caught a disconnect before actually accepting the session */
690 if (session->session_state == VCL_STATE_LISTEN)
692 if (!vcl_flag_accepted_session (session, msg->handle,
693 VCL_ACCEPTED_F_CLOSED))
694 VDBG (0, "session was not accepted!");
698 /* If not already reset change state */
699 if (session->session_state != VCL_STATE_DISCONNECT)
700 session->session_state = VCL_STATE_VPP_CLOSING;
706 vppcom_session_shutdown (uint32_t session_handle, int how)
708 vcl_worker_t *wrk = vcl_worker_get_current ();
709 vcl_session_t *session;
710 vcl_session_state_t state;
713 session = vcl_session_get_w_handle (wrk, session_handle);
714 if (PREDICT_FALSE (!session))
715 return VPPCOM_EBADFD;
717 vpp_handle = session->vpp_handle;
718 state = session->session_state;
720 VDBG (1, "session %u [0x%llx] state 0x%x (%s)", session->session_index,
721 vpp_handle, state, vcl_session_state_str (state));
723 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
725 VDBG (0, "ERROR: Cannot shutdown a listen socket!");
726 return VPPCOM_EBADFD;
729 if (how == SHUT_RD || how == SHUT_RDWR)
731 session->flags |= VCL_SESSION_F_RD_SHUTDOWN;
735 session->flags |= VCL_SESSION_F_WR_SHUTDOWN;
737 if (PREDICT_TRUE (state == VCL_STATE_READY))
739 VDBG (1, "session %u [0x%llx]: sending shutdown...",
740 session->session_index, vpp_handle);
742 vcl_send_session_shutdown (wrk, session);
749 vppcom_session_disconnect (u32 session_handle)
751 vcl_worker_t *wrk = vcl_worker_get_current ();
752 vcl_session_t *session, *listen_session;
753 vcl_session_state_t state;
756 session = vcl_session_get_w_handle (wrk, session_handle);
758 return VPPCOM_EBADFD;
760 vpp_handle = session->vpp_handle;
761 state = session->session_state;
763 VDBG (1, "session %u [0x%llx]: disconnecting state (%s)",
764 session->session_index, vpp_handle, vcl_session_state_str (state));
766 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
768 VDBG (0, "ERROR: Cannot disconnect a listen socket!");
769 return VPPCOM_EBADFD;
772 if (state == VCL_STATE_VPP_CLOSING)
774 vcl_send_session_disconnected_reply (wrk, session, 0);
775 VDBG (1, "session %u [0x%llx]: sending disconnect REPLY...",
776 session->session_index, vpp_handle);
780 /* Session doesn't have an event queue yet. Probably a non-blocking
781 * connect. Wait for the reply */
782 if (PREDICT_FALSE (!session->vpp_evt_q))
785 VDBG (1, "session %u [0x%llx]: sending disconnect",
786 session->session_index, vpp_handle);
787 vcl_send_session_disconnect (wrk, session);
790 if (session->listener_index != VCL_INVALID_SESSION_INDEX)
792 listen_session = vcl_session_get (wrk, session->listener_index);
793 listen_session->n_accepted_sessions--;
800 vcl_session_cleanup_handler (vcl_worker_t * wrk, void *data)
802 session_cleanup_msg_t *msg;
803 vcl_session_t *session;
805 msg = (session_cleanup_msg_t *) data;
806 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
809 VWRN ("disconnect confirmed for unknown handle 0x%llx", msg->handle);
813 if (msg->type == SESSION_CLEANUP_TRANSPORT)
815 /* Transport was cleaned up before we confirmed close. Probably the
816 * app is still waiting for some data that cannot be delivered.
817 * Confirm close to make sure everything is cleaned up.
818 * Move to undetermined state to ensure that the session is not
819 * removed before both vpp and the app cleanup.
820 * - If the app closes first, the session is moved to CLOSED state
821 * and the session cleanup notification from vpp removes the
823 * - If vpp cleans up the session first, the session is moved to
824 * DETACHED state lower and subsequently the close from the app
827 if (session->session_state == VCL_STATE_VPP_CLOSING)
829 vppcom_session_disconnect (vcl_session_handle (session));
830 session->session_state = VCL_STATE_UPDATED;
832 else if (session->session_state == VCL_STATE_DISCONNECT)
834 vcl_send_session_reset_reply (wrk, session, 0);
835 session->session_state = VCL_STATE_UPDATED;
840 /* VPP will reuse the handle so clean it up now */
841 vcl_session_table_del_vpp_handle (wrk, msg->handle);
843 /* App did not close the connection yet so don't free it. */
844 if (session->session_state != VCL_STATE_CLOSED)
846 VDBG (0, "session %u: app did not close", session->session_index);
847 session->session_state = VCL_STATE_DETACHED;
848 session->vpp_handle = VCL_INVALID_SESSION_HANDLE;
852 /* Session probably tracked with epoll, disconnect not yet handled and
853 * 1) both transport and session cleanup completed 2) app closed. Wait
854 * until message is drained to free the session.
855 * See @ref vcl_handle_mq_event */
856 if (session->flags & VCL_SESSION_F_PENDING_DISCONNECT)
858 session->flags |= VCL_SESSION_F_PENDING_FREE;
862 vcl_session_free (wrk, session);
866 vcl_session_req_worker_update_handler (vcl_worker_t * wrk, void *data)
868 session_req_worker_update_msg_t *msg;
871 msg = (session_req_worker_update_msg_t *) data;
872 s = vcl_session_get_w_vpp_handle (wrk, msg->session_handle);
876 vec_add1 (wrk->pending_session_wrk_updates, s->session_index);
880 vcl_session_worker_update_reply_handler (vcl_worker_t * wrk, void *data)
882 session_worker_update_reply_msg_t *msg;
885 msg = (session_worker_update_reply_msg_t *) data;
886 s = vcl_session_get_w_vpp_handle (wrk, msg->handle);
889 VDBG (0, "unknown handle 0x%llx", msg->handle);
895 if (vcl_segment_attach_session (msg->segment_handle, msg->rx_fifo,
896 msg->tx_fifo, (uword) ~0, ~0, 0, s))
898 VDBG (0, "failed to attach fifos for %u", s->session_index);
902 s->session_state = VCL_STATE_UPDATED;
904 VDBG (0, "session %u[0x%llx] moved to worker %u", s->session_index,
905 s->vpp_handle, wrk->wrk_index);
909 vcl_api_recv_fd (vcl_worker_t * wrk, int *fds, int n_fds)
912 if (vcm->cfg.vpp_app_socket_api)
913 return vcl_sapi_recv_fds (wrk, fds, n_fds);
915 return vcl_bapi_recv_fds (wrk, fds, n_fds);
919 vcl_session_app_add_segment_handler (vcl_worker_t * wrk, void *data)
921 ssvm_segment_type_t seg_type = SSVM_SEGMENT_SHM;
922 session_app_add_segment_msg_t *msg;
926 msg = (session_app_add_segment_msg_t *) data;
930 vcl_api_recv_fd (wrk, &fd, 1);
931 seg_type = SSVM_SEGMENT_MEMFD;
934 segment_handle = msg->segment_handle;
935 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
937 clib_warning ("invalid segment handle");
941 if (vcl_segment_attach (segment_handle, (char *) msg->segment_name,
944 VDBG (0, "vcl_segment_attach ('%s') failed", msg->segment_name);
948 VDBG (1, "mapped new segment '%s' size %d", msg->segment_name,
953 vcl_session_app_del_segment_handler (vcl_worker_t * wrk, void *data)
955 session_app_del_segment_msg_t *msg = (session_app_del_segment_msg_t *) data;
956 vcl_segment_detach (msg->segment_handle);
957 VDBG (1, "Unmapped segment: %d", msg->segment_handle);
961 vcl_worker_rpc_handler (vcl_worker_t * wrk, void *data)
963 if (!vcm->wrk_rpc_fn)
966 (vcm->wrk_rpc_fn) (((session_app_wrk_rpc_msg_t *) data)->data);
970 vcl_session_transport_attr_reply_handler (vcl_worker_t *wrk, void *data)
972 session_transport_attr_reply_msg_t *mp;
974 if (!wrk->session_attr_op)
977 mp = (session_transport_attr_reply_msg_t *) data;
979 wrk->session_attr_op_rv = mp->retval;
980 wrk->session_attr_op = 0;
981 wrk->session_attr_rv = mp->attr;
985 vcl_handle_mq_event (vcl_worker_t * wrk, session_event_t * e)
987 session_disconnected_msg_t *disconnected_msg;
988 session_connected_msg_t *connected_msg;
989 session_reset_msg_t *reset_msg;
990 session_event_t *ecpy;
994 switch (e->event_type)
996 case SESSION_IO_EVT_RX:
997 case SESSION_IO_EVT_TX:
998 s = vcl_session_get (wrk, e->session_index);
999 if (!s || !vcl_session_is_open (s))
1001 vec_add1 (wrk->unhandled_evts_vector, *e);
1003 case SESSION_CTRL_EVT_BOUND:
1004 /* We can only wait for only one listen so not postponed */
1005 vcl_session_bound_handler (wrk, (session_bound_msg_t *) e->data);
1007 case SESSION_CTRL_EVT_ACCEPTED:
1008 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
1009 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1011 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1013 ecpy->postponed = 1;
1014 ecpy->session_index = s->session_index;
1017 case SESSION_CTRL_EVT_CONNECTED:
1018 connected_msg = (session_connected_msg_t *) e->data;
1019 sid = vcl_session_connected_handler (wrk, connected_msg);
1020 if (!(s = vcl_session_get (wrk, sid)))
1022 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1024 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1026 ecpy->postponed = 1;
1027 ecpy->session_index = s->session_index;
1030 case SESSION_CTRL_EVT_DISCONNECTED:
1031 disconnected_msg = (session_disconnected_msg_t *) e->data;
1032 if (!(s = vcl_session_get_w_vpp_handle (wrk, disconnected_msg->handle)))
1034 if (s->session_state == VCL_STATE_CLOSED)
1036 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1038 s->session_state = VCL_STATE_VPP_CLOSING;
1039 s->flags |= VCL_SESSION_F_PENDING_DISCONNECT;
1040 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1042 ecpy->postponed = 1;
1043 ecpy->session_index = s->session_index;
1046 if (!(s = vcl_session_disconnected_handler (wrk, disconnected_msg)))
1048 VDBG (0, "disconnected session %u [0x%llx]", s->session_index,
1051 case SESSION_CTRL_EVT_RESET:
1052 reset_msg = (session_reset_msg_t *) e->data;
1053 if (!(s = vcl_session_get_w_vpp_handle (wrk, reset_msg->handle)))
1055 if (s->session_state == VCL_STATE_CLOSED)
1057 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1059 s->flags |= VCL_SESSION_F_PENDING_DISCONNECT;
1060 s->session_state = VCL_STATE_DISCONNECT;
1061 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1063 ecpy->postponed = 1;
1064 ecpy->session_index = s->session_index;
1067 vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
1069 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
1070 vcl_session_unlisten_reply_handler (wrk, e->data);
1072 case SESSION_CTRL_EVT_MIGRATED:
1073 vcl_session_migrated_handler (wrk, e->data);
1075 case SESSION_CTRL_EVT_CLEANUP:
1076 vcl_session_cleanup_handler (wrk, e->data);
1078 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
1079 vcl_session_req_worker_update_handler (wrk, e->data);
1081 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
1082 vcl_session_worker_update_reply_handler (wrk, e->data);
1084 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
1085 vcl_session_app_add_segment_handler (wrk, e->data);
1087 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
1088 vcl_session_app_del_segment_handler (wrk, e->data);
1090 case SESSION_CTRL_EVT_APP_WRK_RPC:
1091 vcl_worker_rpc_handler (wrk, e->data);
1093 case SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY:
1094 vcl_session_transport_attr_reply_handler (wrk, e->data);
1097 clib_warning ("unhandled %u", e->event_type);
1103 vppcom_wait_for_session_state_change (u32 session_index,
1104 vcl_session_state_t state,
1107 vcl_worker_t *wrk = vcl_worker_get_current ();
1108 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
1109 vcl_session_t *volatile session;
1110 svm_msg_q_msg_t msg;
1115 session = vcl_session_get (wrk, session_index);
1116 if (PREDICT_FALSE (!session))
1118 return VPPCOM_EBADFD;
1120 if (session->session_state == state)
1124 if (session->session_state == VCL_STATE_DETACHED)
1126 return VPPCOM_ECONNREFUSED;
1129 if (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0))
1134 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
1135 vcl_handle_mq_event (wrk, e);
1136 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
1138 while (clib_time_now (&wrk->clib_time) < timeout);
1140 VDBG (0, "timeout waiting for state 0x%x (%s)", state,
1141 vcl_session_state_str (state));
1142 vcl_evt (VCL_EVT_SESSION_TIMEOUT, session, session_state);
1144 return VPPCOM_ETIMEDOUT;
1148 vcl_handle_pending_wrk_updates (vcl_worker_t * wrk)
1150 vcl_session_state_t state;
1154 if (PREDICT_TRUE (vec_len (wrk->pending_session_wrk_updates) == 0))
1157 vec_foreach (sip, wrk->pending_session_wrk_updates)
1159 s = vcl_session_get (wrk, *sip);
1160 vcl_send_session_worker_update (wrk, s, wrk->wrk_index);
1161 state = s->session_state;
1162 vppcom_wait_for_session_state_change (s->session_index, VCL_STATE_UPDATED,
1164 s->session_state = state;
1166 vec_reset_length (wrk->pending_session_wrk_updates);
1170 vcl_worker_flush_mq_events (vcl_worker_t *wrk)
1172 svm_msg_q_msg_t *msg;
1177 mq = wrk->app_event_queue;
1178 vcl_mq_dequeue_batch (wrk, mq, ~0);
1180 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
1182 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
1183 e = svm_msg_q_msg_data (mq, msg);
1184 vcl_handle_mq_event (wrk, e);
1185 svm_msg_q_free_msg (mq, msg);
1187 vec_reset_length (wrk->mq_msg_vector);
1188 vcl_handle_pending_wrk_updates (wrk);
1192 vcl_flush_mq_events (void)
1194 vcl_worker_flush_mq_events (vcl_worker_get_current ());
1198 vppcom_session_unbind (u32 session_handle)
1200 vcl_worker_t *wrk = vcl_worker_get_current ();
1201 session_accepted_msg_t *accepted_msg;
1202 vcl_session_t *session = 0;
1203 vcl_session_msg_t *evt;
1205 session = vcl_session_get_w_handle (wrk, session_handle);
1207 return VPPCOM_EBADFD;
1209 /* Flush pending accept events, if any */
1210 while (clib_fifo_elts (session->accept_evts_fifo))
1212 clib_fifo_sub2 (session->accept_evts_fifo, evt);
1213 accepted_msg = &evt->accepted_msg;
1214 vcl_session_table_del_vpp_handle (wrk, accepted_msg->handle);
1215 vcl_send_session_accepted_reply (session->vpp_evt_q,
1216 accepted_msg->context,
1217 accepted_msg->handle, -1);
1219 clib_fifo_free (session->accept_evts_fifo);
1221 vcl_send_session_unlisten (wrk, session);
1223 VDBG (1, "session %u [0x%llx]: sending unbind!", session->session_index,
1224 session->vpp_handle);
1225 vcl_evt (VCL_EVT_UNBIND, session);
1227 session->vpp_handle = ~0;
1228 session->session_state = VCL_STATE_DISCONNECT;
1236 * Notify vpp of the disconnect and mark the worker as free. If we're the
1237 * last worker, do a full cleanup otherwise, since we're probably a forked
1238 * child, avoid syscalls as much as possible. We might've lost privileges.
1241 vppcom_app_exit (void)
1243 if (!pool_elts (vcm->workers))
1245 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
1246 vcl_set_worker_index (~0);
1247 vcl_elog_stop (vcm);
1251 vcl_api_attach (void)
1253 if (vcm->cfg.vpp_app_socket_api)
1254 return vcl_sapi_attach ();
1256 return vcl_bapi_attach ();
1260 vcl_api_retry_attach (vcl_worker_t *wrk)
1264 if (vcl_api_attach ())
1267 /* Treat listeners as configuration that needs to be re-added to vpp */
1268 pool_foreach (s, wrk->sessions)
1270 if (s->flags & VCL_SESSION_F_IS_VEP)
1272 if (s->session_state == VCL_STATE_LISTEN_NO_MQ)
1273 vppcom_session_listen (vcl_session_handle (s), 10);
1275 VDBG (0, "internal error: unexpected state %d", s->session_state);
1280 vcl_api_handle_disconnect (vcl_worker_t *wrk)
1282 wrk->api_client_handle = ~0;
1283 vcl_worker_detach_sessions (wrk);
1287 vcl_api_detach (vcl_worker_t * wrk)
1289 if (wrk->api_client_handle == ~0)
1292 vcl_send_app_detach (wrk);
1294 if (vcm->cfg.vpp_app_socket_api)
1295 return vcl_sapi_detach (wrk);
1297 return vcl_bapi_disconnect_from_vpp ();
1301 * VPPCOM Public API functions
1304 vppcom_app_create (const char *app_name)
1306 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1311 VDBG (1, "already initialized");
1312 return VPPCOM_EEXIST;
1316 vppcom_cfg (&vcm->cfg);
1317 vcl_cfg = &vcm->cfg;
1319 vcm->main_cpu = pthread_self ();
1320 vcm->main_pid = getpid ();
1321 vcm->app_name = format (0, "%s", app_name);
1322 fifo_segment_main_init (&vcm->segment_main, (uword) ~0,
1323 20 /* timeout in secs */);
1324 pool_alloc (vcm->workers, vcl_cfg->max_workers);
1325 clib_spinlock_init (&vcm->workers_lock);
1326 clib_rwlock_init (&vcm->segment_table_lock);
1327 atexit (vppcom_app_exit);
1328 vcl_elog_init (vcm);
1330 /* Allocate default worker */
1331 vcl_worker_alloc_and_init ();
1333 if ((rv = vcl_api_attach ()))
1335 vppcom_app_destroy ();
1339 VDBG (0, "app_name '%s', my_client_index %d (0x%x)", app_name,
1340 vcm->workers[0].api_client_handle, vcm->workers[0].api_client_handle);
1346 vppcom_app_destroy (void)
1348 vcl_worker_t *wrk, *current_wrk;
1351 if (!pool_elts (vcm->workers))
1354 vcl_evt (VCL_EVT_DETACH, vcm);
1356 current_wrk = vcl_worker_get_current ();
1359 pool_foreach (wrk, vcm->workers) {
1360 if (current_wrk != wrk)
1361 vcl_worker_cleanup (wrk, 0 /* notify vpp */ );
1365 vcl_api_detach (current_wrk);
1366 vcl_worker_cleanup (current_wrk, 0 /* notify vpp */ );
1367 vcl_set_worker_index (~0);
1369 vcl_elog_stop (vcm);
1372 * Free the heap and fix vcm
1374 heap = clib_mem_get_heap ();
1375 munmap (clib_mem_get_heap_base (heap), clib_mem_get_heap_size (heap));
1377 vcm = &_vppcom_main;
1382 vppcom_session_create (u8 proto, u8 is_nonblocking)
1384 vcl_worker_t *wrk = vcl_worker_get_current ();
1385 vcl_session_t *session;
1387 session = vcl_session_alloc (wrk);
1389 session->session_type = proto;
1390 session->session_state = VCL_STATE_CLOSED;
1391 session->vpp_handle = ~0;
1392 session->is_dgram = vcl_proto_is_dgram (proto);
1395 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
1397 vcl_evt (VCL_EVT_CREATE, session, session_type, session->session_state,
1398 is_nonblocking, session_index);
1400 VDBG (0, "created session %u", session->session_index);
1402 return vcl_session_handle (session);
1406 vcl_epoll_lt_add (vcl_worker_t *wrk, vcl_session_t *s)
1408 vcl_session_t *cur, *prev;
1410 if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX)
1412 wrk->ep_lt_current = s->session_index;
1413 s->vep.lt_next = s->session_index;
1414 s->vep.lt_prev = s->session_index;
1418 cur = vcl_session_get (wrk, wrk->ep_lt_current);
1419 prev = vcl_session_get (wrk, cur->vep.lt_prev);
1421 prev->vep.lt_next = s->session_index;
1422 s->vep.lt_prev = prev->session_index;
1424 s->vep.lt_next = cur->session_index;
1425 cur->vep.lt_prev = s->session_index;
1429 vcl_epoll_lt_del (vcl_worker_t *wrk, vcl_session_t *s)
1431 vcl_session_t *prev, *next;
1433 if (s->vep.lt_next == s->session_index)
1435 wrk->ep_lt_current = VCL_INVALID_SESSION_INDEX;
1436 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
1440 prev = vcl_session_get (wrk, s->vep.lt_prev);
1441 next = vcl_session_get (wrk, s->vep.lt_next);
1443 prev->vep.lt_next = next->session_index;
1444 next->vep.lt_prev = prev->session_index;
1446 if (s->session_index == wrk->ep_lt_current)
1447 wrk->ep_lt_current = s->vep.lt_next;
1449 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
1453 vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * s,
1454 vcl_session_handle_t sh, u8 do_disconnect)
1458 VDBG (1, "session %u [0x%llx] closing", s->session_index, s->vpp_handle);
1460 if (s->flags & VCL_SESSION_F_IS_VEP)
1462 u32 next_sh = s->vep.next_sh;
1463 while (next_sh != ~0)
1465 rv = vppcom_epoll_ctl (sh, EPOLL_CTL_DEL, next_sh, 0);
1466 if (PREDICT_FALSE (rv < 0))
1467 VDBG (0, "vpp handle 0x%llx, sh %u: EPOLL_CTL_DEL vep_idx %u"
1468 " failed! rv %d (%s)", s->vpp_handle, next_sh,
1469 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1470 next_sh = s->vep.next_sh;
1475 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
1477 rv = vppcom_epoll_ctl (s->vep.vep_sh, EPOLL_CTL_DEL, sh, 0);
1479 VDBG (0, "session %u [0x%llx]: EPOLL_CTL_DEL vep_idx %u "
1480 "failed! rv %d (%s)", s->session_index, s->vpp_handle,
1481 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1486 VDBG (1, "session %u [0x%llx] disconnect skipped",
1487 s->session_index, s->vpp_handle);
1491 if (s->session_state == VCL_STATE_LISTEN)
1493 rv = vppcom_session_unbind (sh);
1494 if (PREDICT_FALSE (rv < 0))
1495 VDBG (0, "session %u [0x%llx]: listener unbind failed! "
1496 "rv %d (%s)", s->session_index, s->vpp_handle, rv,
1497 vppcom_retval_str (rv));
1500 else if (vcl_session_is_ready (s)
1501 || (vcl_session_is_connectable_listener (wrk, s)))
1503 rv = vppcom_session_disconnect (sh);
1504 if (PREDICT_FALSE (rv < 0))
1505 VDBG (0, "ERROR: session %u [0x%llx]: disconnect failed!"
1506 " rv %d (%s)", s->session_index, s->vpp_handle,
1507 rv, vppcom_retval_str (rv));
1509 else if (s->session_state == VCL_STATE_DISCONNECT)
1511 vcl_send_session_reset_reply (wrk, s, 0);
1513 else if (s->session_state == VCL_STATE_DETACHED)
1515 VDBG (0, "vpp freed session %d before close", s->session_index);
1517 if (!(s->flags & VCL_SESSION_F_PENDING_DISCONNECT))
1520 /* Disconnect/reset messages pending but vpp transport and session
1521 * cleanups already done. Free only after messages drained. */
1522 s->flags |= VCL_SESSION_F_PENDING_FREE;
1525 s->session_state = VCL_STATE_CLOSED;
1527 /* Session is removed only after vpp confirms the disconnect */
1531 vcl_session_table_del_vpp_handle (wrk, s->vpp_handle);
1533 vcl_session_free (wrk, s);
1534 vcl_evt (VCL_EVT_CLOSE, s, rv);
1540 vppcom_session_close (uint32_t session_handle)
1542 vcl_worker_t *wrk = vcl_worker_get_current ();
1543 vcl_session_t *session;
1545 session = vcl_session_get_w_handle (wrk, session_handle);
1547 return VPPCOM_EBADFD;
1548 return vcl_session_cleanup (wrk, session, session_handle,
1549 1 /* do_disconnect */ );
1553 vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep)
1555 vcl_worker_t *wrk = vcl_worker_get_current ();
1556 vcl_session_t *session = 0;
1559 return VPPCOM_EINVAL;
1561 session = vcl_session_get_w_handle (wrk, session_handle);
1563 return VPPCOM_EBADFD;
1565 if (session->flags & VCL_SESSION_F_IS_VEP)
1567 VDBG (0, "ERROR: cannot bind to epoll session %u!",
1568 session->session_index);
1569 return VPPCOM_EBADFD;
1572 session->transport.is_ip4 = ep->is_ip4;
1574 clib_memcpy_fast (&session->transport.lcl_ip.ip4, ep->ip,
1575 sizeof (ip4_address_t));
1577 clib_memcpy_fast (&session->transport.lcl_ip.ip6, ep->ip,
1578 sizeof (ip6_address_t));
1579 session->transport.lcl_port = ep->port;
1582 "session %u handle %u: binding to local %s address %U port %u, "
1584 session->session_index, session_handle,
1585 session->transport.is_ip4 ? "IPv4" : "IPv6", vcl_format_ip46_address,
1586 &session->transport.lcl_ip,
1587 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1588 clib_net_to_host_u16 (session->transport.lcl_port),
1589 vppcom_proto_str (session->session_type));
1590 vcl_evt (VCL_EVT_BIND, session);
1592 if (session->session_type == VPPCOM_PROTO_UDP)
1593 vppcom_session_listen (session_handle, 10);
1599 vppcom_session_listen (uint32_t listen_sh, uint32_t q_len)
1601 vcl_worker_t *wrk = vcl_worker_get_current ();
1602 vcl_session_t *listen_session = 0;
1603 u64 listen_vpp_handle;
1606 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1607 if (!listen_session || (listen_session->flags & VCL_SESSION_F_IS_VEP))
1608 return VPPCOM_EBADFD;
1610 listen_vpp_handle = listen_session->vpp_handle;
1611 if (listen_session->session_state == VCL_STATE_LISTEN)
1613 VDBG (0, "session %u [0x%llx]: already in listen state!",
1614 listen_sh, listen_vpp_handle);
1618 VDBG (0, "session %u: sending vpp listen request...", listen_sh);
1621 * Send listen request to vpp and wait for reply
1623 vcl_send_session_listen (wrk, listen_session);
1624 rv = vppcom_wait_for_session_state_change (listen_session->session_index,
1626 vcm->cfg.session_timeout);
1628 if (PREDICT_FALSE (rv))
1630 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1631 VDBG (0, "session %u [0x%llx]: listen failed! returning %d (%s)",
1632 listen_sh, listen_session->vpp_handle, rv,
1633 vppcom_retval_str (rv));
1641 validate_args_session_accept_ (vcl_worker_t * wrk, vcl_session_t * ls)
1643 if (ls->flags & VCL_SESSION_F_IS_VEP)
1645 VDBG (0, "ERROR: cannot accept on epoll session %u!",
1647 return VPPCOM_EBADFD;
1650 if ((ls->session_state != VCL_STATE_LISTEN)
1651 && (!vcl_session_is_connectable_listener (wrk, ls)))
1654 "ERROR: session [0x%llx]: not in listen state! state 0x%x"
1656 ls->vpp_handle, ls->session_state,
1657 vcl_session_state_str (ls->session_state));
1658 return VPPCOM_EBADFD;
1664 vppcom_unformat_proto (uint8_t * proto, char *proto_str)
1666 if (!strcmp (proto_str, "TCP"))
1667 *proto = VPPCOM_PROTO_TCP;
1668 else if (!strcmp (proto_str, "tcp"))
1669 *proto = VPPCOM_PROTO_TCP;
1670 else if (!strcmp (proto_str, "UDP"))
1671 *proto = VPPCOM_PROTO_UDP;
1672 else if (!strcmp (proto_str, "udp"))
1673 *proto = VPPCOM_PROTO_UDP;
1674 else if (!strcmp (proto_str, "TLS"))
1675 *proto = VPPCOM_PROTO_TLS;
1676 else if (!strcmp (proto_str, "tls"))
1677 *proto = VPPCOM_PROTO_TLS;
1678 else if (!strcmp (proto_str, "QUIC"))
1679 *proto = VPPCOM_PROTO_QUIC;
1680 else if (!strcmp (proto_str, "quic"))
1681 *proto = VPPCOM_PROTO_QUIC;
1682 else if (!strcmp (proto_str, "DTLS"))
1683 *proto = VPPCOM_PROTO_DTLS;
1684 else if (!strcmp (proto_str, "dtls"))
1685 *proto = VPPCOM_PROTO_DTLS;
1686 else if (!strcmp (proto_str, "SRTP"))
1687 *proto = VPPCOM_PROTO_SRTP;
1688 else if (!strcmp (proto_str, "srtp"))
1689 *proto = VPPCOM_PROTO_SRTP;
1696 vppcom_session_accept (uint32_t listen_session_handle, vppcom_endpt_t * ep,
1699 u32 client_session_index = ~0, listen_session_index, accept_flags = 0;
1700 vcl_worker_t *wrk = vcl_worker_get_current ();
1701 session_accepted_msg_t accepted_msg;
1702 vcl_session_t *listen_session = 0;
1703 vcl_session_t *client_session = 0;
1704 vcl_session_msg_t *evt;
1710 listen_session = vcl_session_get_w_handle (wrk, listen_session_handle);
1711 if (!listen_session)
1712 return VPPCOM_EBADFD;
1714 listen_session_index = listen_session->session_index;
1715 if ((rv = validate_args_session_accept_ (wrk, listen_session)))
1718 if (clib_fifo_elts (listen_session->accept_evts_fifo))
1720 clib_fifo_sub2 (listen_session->accept_evts_fifo, evt);
1721 accept_flags = evt->flags;
1722 accepted_msg = evt->accepted_msg;
1726 is_nonblocking = vcl_session_has_attr (listen_session,
1727 VCL_SESS_ATTR_NONBLOCK);
1730 if (svm_msg_q_is_empty (wrk->app_event_queue) && is_nonblocking)
1731 return VPPCOM_EAGAIN;
1733 svm_msg_q_wait (wrk->app_event_queue, SVM_MQ_WAIT_EMPTY);
1734 vcl_worker_flush_mq_events (wrk);
1740 client_session_index = vcl_session_accepted_handler (wrk, &accepted_msg,
1741 listen_session_index);
1742 if (client_session_index == VCL_INVALID_SESSION_INDEX)
1743 return VPPCOM_ECONNABORTED;
1745 listen_session = vcl_session_get (wrk, listen_session_index);
1746 client_session = vcl_session_get (wrk, client_session_index);
1748 if (flags & O_NONBLOCK)
1749 vcl_session_set_attr (client_session, VCL_SESS_ATTR_NONBLOCK);
1751 VDBG (1, "listener %u [0x%llx]: Got a connect request! session %u [0x%llx],"
1752 " flags %d, is_nonblocking %u", listen_session->session_index,
1753 listen_session->vpp_handle, client_session_index,
1754 client_session->vpp_handle, flags,
1755 vcl_session_has_attr (client_session, VCL_SESS_ATTR_NONBLOCK));
1759 ep->is_ip4 = client_session->transport.is_ip4;
1760 ep->port = client_session->transport.rmt_port;
1761 if (client_session->transport.is_ip4)
1762 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip4,
1763 sizeof (ip4_address_t));
1765 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip6,
1766 sizeof (ip6_address_t));
1770 "listener %u [0x%llx] accepted %u [0x%llx] peer: %U:%u "
1772 listen_session_handle, listen_session->vpp_handle,
1773 client_session_index, client_session->vpp_handle,
1774 vcl_format_ip46_address, &client_session->transport.rmt_ip,
1775 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1776 clib_net_to_host_u16 (client_session->transport.rmt_port),
1777 vcl_format_ip46_address, &client_session->transport.lcl_ip,
1778 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1779 clib_net_to_host_u16 (client_session->transport.lcl_port));
1780 vcl_evt (VCL_EVT_ACCEPT, client_session, listen_session,
1781 client_session_index);
1784 * Session might have been closed already
1788 if (accept_flags & VCL_ACCEPTED_F_CLOSED)
1789 client_session->session_state = VCL_STATE_VPP_CLOSING;
1790 else if (accept_flags & VCL_ACCEPTED_F_RESET)
1791 client_session->session_state = VCL_STATE_DISCONNECT;
1793 return vcl_session_handle (client_session);
1797 vppcom_session_connect (uint32_t session_handle, vppcom_endpt_t * server_ep)
1799 vcl_worker_t *wrk = vcl_worker_get_current ();
1800 vcl_session_t *session = 0;
1804 session = vcl_session_get_w_handle (wrk, session_handle);
1806 return VPPCOM_EBADFD;
1807 session_index = session->session_index;
1809 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1811 VWRN ("cannot connect epoll session %u!", session->session_index);
1812 return VPPCOM_EBADFD;
1815 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1818 "session %u [0x%llx]: already connected to %U:%d proto %s,"
1820 session->session_index, session->vpp_handle,
1821 vcl_format_ip46_address, &session->transport.rmt_ip,
1822 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1823 clib_net_to_host_u16 (session->transport.rmt_port),
1824 vppcom_proto_str (session->session_type),
1825 vcl_session_state_str (session->session_state));
1829 /* Attempt to connect a connectionless listener */
1830 if (PREDICT_FALSE (session->session_state == VCL_STATE_LISTEN))
1832 if (session->session_type != VPPCOM_PROTO_UDP)
1833 return VPPCOM_EINVAL;
1834 vcl_send_session_unlisten (wrk, session);
1835 session->session_state = VCL_STATE_CLOSED;
1838 session->transport.is_ip4 = server_ep->is_ip4;
1839 vcl_ip_copy_from_ep (&session->transport.rmt_ip, server_ep);
1840 session->transport.rmt_port = server_ep->port;
1841 session->parent_handle = VCL_INVALID_SESSION_HANDLE;
1842 session->flags |= VCL_SESSION_F_CONNECTED;
1844 VDBG (0, "session %u: connecting to peer %U:%d proto %s",
1845 session->session_index, vcl_format_ip46_address,
1846 &session->transport.rmt_ip,
1847 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1848 clib_net_to_host_u16 (session->transport.rmt_port),
1849 vppcom_proto_str (session->session_type));
1851 vcl_send_session_connect (wrk, session);
1853 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK))
1855 /* State set to STATE_UPDATED to ensure the session is not assumed
1856 * to be ready and to also allow the app to close it prior to vpp's
1857 * connected reply. */
1858 session->session_state = VCL_STATE_UPDATED;
1859 return VPPCOM_EINPROGRESS;
1863 * Wait for reply from vpp if blocking
1865 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1866 vcm->cfg.session_timeout);
1868 session = vcl_session_get (wrk, session_index);
1869 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1870 session->vpp_handle, rv ? "failed" : "succeeded");
1876 vppcom_session_stream_connect (uint32_t session_handle,
1877 uint32_t parent_session_handle)
1879 vcl_worker_t *wrk = vcl_worker_get_current ();
1880 vcl_session_t *session, *parent_session;
1881 u32 session_index, parent_session_index;
1884 session = vcl_session_get_w_handle (wrk, session_handle);
1886 return VPPCOM_EBADFD;
1887 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1888 if (!parent_session)
1889 return VPPCOM_EBADFD;
1891 session_index = session->session_index;
1892 parent_session_index = parent_session->session_index;
1893 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1895 VDBG (0, "ERROR: cannot connect epoll session %u!",
1896 session->session_index);
1897 return VPPCOM_EBADFD;
1900 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1903 "session handle %u [0x%llx]: session already "
1904 "connected to session %u [0x%llx] proto %s, state 0x%x (%s)",
1905 session_handle, session->vpp_handle, parent_session_handle,
1906 parent_session->vpp_handle,
1907 vppcom_proto_str (session->session_type), session->session_state,
1908 vcl_session_state_str (session->session_state));
1912 /* Connect to quic session specifics */
1913 session->transport.is_ip4 = parent_session->transport.is_ip4;
1914 session->transport.rmt_ip.ip4.as_u32 = (uint32_t) 1;
1915 session->transport.rmt_port = 0;
1916 session->parent_handle = parent_session->vpp_handle;
1918 VDBG (0, "session handle %u: connecting to session %u [0x%llx]",
1919 session_handle, parent_session_handle, parent_session->vpp_handle);
1922 * Send connect request and wait for reply from vpp
1924 vcl_send_session_connect (wrk, session);
1925 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1926 vcm->cfg.session_timeout);
1928 session->listener_index = parent_session_index;
1929 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1931 parent_session->n_accepted_sessions++;
1933 session = vcl_session_get (wrk, session_index);
1934 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1935 session->vpp_handle, rv ? "failed" : "succeeded");
1941 vppcom_session_read_internal (uint32_t session_handle, void *buf, int n,
1944 vcl_worker_t *wrk = vcl_worker_get_current ();
1945 int rv, n_read = 0, is_nonblocking;
1946 vcl_session_t *s = 0;
1947 svm_fifo_t *rx_fifo;
1952 if (PREDICT_FALSE (!buf))
1953 return VPPCOM_EFAULT;
1955 s = vcl_session_get_w_handle (wrk, session_handle);
1956 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
1957 return VPPCOM_EBADFD;
1959 if (PREDICT_FALSE (!vcl_session_is_open (s)))
1961 VDBG (0, "session %u[0x%llx] is not open! state 0x%x (%s)",
1962 s->session_index, s->vpp_handle, s->session_state,
1963 vcl_session_state_str (s->session_state));
1964 return vcl_session_closed_error (s);
1967 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_RD_SHUTDOWN))
1969 /* Vpp would ack the incoming data and enqueue it for reading.
1970 * So even if SHUT_RD is set, we can still read() the data if
1971 * the session is ready.
1973 if (!vcl_session_read_ready (s))
1979 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
1980 is_ct = vcl_session_is_ct (s);
1981 mq = wrk->app_event_queue;
1982 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
1983 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
1985 if (svm_fifo_is_empty_cons (rx_fifo))
1989 if (vcl_session_is_closing (s))
1990 return vcl_session_closing_error (s);
1992 svm_fifo_unset_event (s->rx_fifo);
1993 svm_fifo_unset_event (rx_fifo);
1994 return VPPCOM_EWOULDBLOCK;
1996 while (svm_fifo_is_empty_cons (rx_fifo))
1998 if (vcl_session_is_closing (s))
1999 return vcl_session_closing_error (s);
2002 svm_fifo_unset_event (s->rx_fifo);
2003 svm_fifo_unset_event (rx_fifo);
2005 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2006 vcl_worker_flush_mq_events (wrk);
2013 rv = app_recv_dgram_raw (rx_fifo, buf, n, &s->transport, 0, peek);
2015 rv = app_recv_stream_raw (rx_fifo, buf, n, 0, peek);
2024 if (svm_fifo_is_empty_cons (rx_fifo))
2027 svm_fifo_unset_event (s->rx_fifo);
2028 svm_fifo_unset_event (rx_fifo);
2029 if (!svm_fifo_is_empty_cons (rx_fifo)
2030 && svm_fifo_set_event (rx_fifo) && is_nonblocking)
2032 vec_add2 (wrk->unhandled_evts_vector, e, 1);
2033 e->event_type = SESSION_IO_EVT_RX;
2034 e->session_index = s->session_index;
2037 else if (PREDICT_FALSE (rv < n && !s->is_dgram))
2039 /* More data enqueued while reading. Try to drain it
2040 * or fill the buffer. Avoid doing that for dgrams */
2046 if (PREDICT_FALSE (svm_fifo_needs_deq_ntf (rx_fifo, n_read)))
2048 svm_fifo_clear_deq_ntf (rx_fifo);
2049 app_send_io_evt_to_vpp (s->vpp_evt_q,
2050 s->rx_fifo->shr->master_session_index,
2051 SESSION_IO_EVT_RX, SVM_Q_WAIT);
2054 VDBG (2, "session %u[0x%llx]: read %d bytes from (%p)", s->session_index,
2055 s->vpp_handle, n_read, rx_fifo);
2061 vppcom_session_read (uint32_t session_handle, void *buf, size_t n)
2063 return (vppcom_session_read_internal (session_handle, buf, n, 0));
2067 vppcom_session_peek (uint32_t session_handle, void *buf, int n)
2069 return (vppcom_session_read_internal (session_handle, buf, n, 1));
2073 vppcom_session_read_segments (uint32_t session_handle,
2074 vppcom_data_segment_t * ds, uint32_t n_segments,
2077 vcl_worker_t *wrk = vcl_worker_get_current ();
2078 int n_read = 0, is_nonblocking;
2079 vcl_session_t *s = 0;
2080 svm_fifo_t *rx_fifo;
2084 s = vcl_session_get_w_handle (wrk, session_handle);
2085 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2086 return VPPCOM_EBADFD;
2088 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2089 return vcl_session_closed_error (s);
2091 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2092 is_ct = vcl_session_is_ct (s);
2093 mq = wrk->app_event_queue;
2094 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
2095 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2097 if (svm_fifo_is_empty_cons (rx_fifo))
2102 svm_fifo_unset_event (s->rx_fifo);
2103 svm_fifo_unset_event (rx_fifo);
2104 return VPPCOM_EWOULDBLOCK;
2106 while (svm_fifo_is_empty_cons (rx_fifo))
2108 if (vcl_session_is_closing (s))
2109 return vcl_session_closing_error (s);
2112 svm_fifo_unset_event (s->rx_fifo);
2113 svm_fifo_unset_event (rx_fifo);
2115 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2116 vcl_worker_flush_mq_events (wrk);
2120 n_read = svm_fifo_segments (rx_fifo, s->rx_bytes_pending,
2121 (svm_fifo_seg_t *) ds, &n_segments, max_bytes);
2123 return VPPCOM_EAGAIN;
2125 if (svm_fifo_max_dequeue_cons (rx_fifo) == n_read)
2128 svm_fifo_unset_event (s->rx_fifo);
2129 svm_fifo_unset_event (rx_fifo);
2130 if (svm_fifo_max_dequeue_cons (rx_fifo) != n_read
2131 && svm_fifo_set_event (rx_fifo)
2132 && vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
2135 vec_add2 (wrk->unhandled_evts_vector, e, 1);
2136 e->event_type = SESSION_IO_EVT_RX;
2137 e->session_index = s->session_index;
2141 s->rx_bytes_pending += n_read;
2146 vppcom_session_free_segments (uint32_t session_handle, uint32_t n_bytes)
2148 vcl_worker_t *wrk = vcl_worker_get_current ();
2152 s = vcl_session_get_w_handle (wrk, session_handle);
2153 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2156 is_ct = vcl_session_is_ct (s);
2157 svm_fifo_dequeue_drop (is_ct ? s->ct_rx_fifo : s->rx_fifo, n_bytes);
2159 ASSERT (s->rx_bytes_pending >= n_bytes);
2160 s->rx_bytes_pending -= n_bytes;
2164 vcl_fifo_is_writeable (svm_fifo_t * f, u32 len, u8 is_dgram)
2166 u32 max_enq = svm_fifo_max_enqueue_prod (f);
2168 return max_enq >= (sizeof (session_dgram_hdr_t) + len);
2174 vppcom_session_write_inline (vcl_worker_t * wrk, vcl_session_t * s, void *buf,
2175 size_t n, u8 is_flush, u8 is_dgram)
2177 int n_write, is_nonblocking;
2178 session_evt_type_t et;
2179 svm_fifo_t *tx_fifo;
2183 /* Accept zero length writes but just return */
2184 if (PREDICT_FALSE (!n))
2187 if (PREDICT_FALSE (!buf))
2188 return VPPCOM_EFAULT;
2190 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2192 VDBG (0, "ERROR: session %u [0x%llx]: cannot write to an epoll"
2193 " session!", s->session_index, s->vpp_handle);
2194 return VPPCOM_EBADFD;
2197 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2199 VDBG (1, "session %u [0x%llx]: is not open! state 0x%x (%s)",
2200 s->session_index, s->vpp_handle, s->session_state,
2201 vcl_session_state_str (s->session_state));
2202 return vcl_session_closed_error (s);;
2205 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_WR_SHUTDOWN))
2207 VDBG (1, "session %u [0x%llx]: is shutdown! state 0x%x (%s)",
2208 s->session_index, s->vpp_handle, s->session_state,
2209 vcl_session_state_str (s->session_state));
2210 return VPPCOM_EPIPE;
2213 is_ct = vcl_session_is_ct (s);
2214 tx_fifo = is_ct ? s->ct_tx_fifo : s->tx_fifo;
2215 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2217 mq = wrk->app_event_queue;
2218 if (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2222 return VPPCOM_EWOULDBLOCK;
2224 while (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2226 svm_fifo_add_want_deq_ntf (tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
2227 if (vcl_session_is_closing (s))
2228 return vcl_session_closing_error (s);
2230 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2231 vcl_worker_flush_mq_events (wrk);
2235 et = SESSION_IO_EVT_TX;
2236 if (is_flush && !is_ct)
2237 et = SESSION_IO_EVT_TX_FLUSH;
2240 n_write = app_send_dgram_raw (tx_fifo, &s->transport,
2241 s->vpp_evt_q, buf, n, et,
2242 0 /* do_evt */ , SVM_Q_WAIT);
2244 n_write = app_send_stream_raw (tx_fifo, s->vpp_evt_q, buf, n, et,
2245 0 /* do_evt */ , SVM_Q_WAIT);
2247 if (svm_fifo_set_event (s->tx_fifo))
2248 app_send_io_evt_to_vpp (
2249 s->vpp_evt_q, s->tx_fifo->shr->master_session_index, et, SVM_Q_WAIT);
2251 /* The underlying fifo segment can run out of memory */
2252 if (PREDICT_FALSE (n_write < 0))
2253 return VPPCOM_EAGAIN;
2255 VDBG (2, "session %u [0x%llx]: wrote %d bytes", s->session_index,
2256 s->vpp_handle, n_write);
2262 vppcom_session_write (uint32_t session_handle, void *buf, size_t n)
2264 vcl_worker_t *wrk = vcl_worker_get_current ();
2267 s = vcl_session_get_w_handle (wrk, session_handle);
2268 if (PREDICT_FALSE (!s))
2269 return VPPCOM_EBADFD;
2271 return vppcom_session_write_inline (wrk, s, buf, n,
2272 0 /* is_flush */ , s->is_dgram ? 1 : 0);
2276 vppcom_session_write_msg (uint32_t session_handle, void *buf, size_t n)
2278 vcl_worker_t *wrk = vcl_worker_get_current ();
2281 s = vcl_session_get_w_handle (wrk, session_handle);
2282 if (PREDICT_FALSE (!s))
2283 return VPPCOM_EBADFD;
2285 return vppcom_session_write_inline (wrk, s, buf, n,
2286 1 /* is_flush */ , s->is_dgram ? 1 : 0);
2289 #define vcl_fifo_rx_evt_valid_or_break(_s) \
2290 if (PREDICT_FALSE (!_s->rx_fifo)) \
2292 if (PREDICT_FALSE (svm_fifo_is_empty (_s->rx_fifo))) \
2294 if (!vcl_session_is_ct (_s)) \
2296 svm_fifo_unset_event (_s->rx_fifo); \
2297 if (svm_fifo_is_empty (_s->rx_fifo)) \
2300 else if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2302 svm_fifo_unset_event (_s->rx_fifo); /* rx evts on actual fifo*/ \
2303 if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2309 vcl_select_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2310 unsigned long n_bits, unsigned long *read_map,
2311 unsigned long *write_map,
2312 unsigned long *except_map, u32 * bits_set)
2314 session_disconnected_msg_t *disconnected_msg;
2315 session_connected_msg_t *connected_msg;
2319 switch (e->event_type)
2321 case SESSION_IO_EVT_RX:
2322 sid = e->session_index;
2323 s = vcl_session_get (wrk, sid);
2324 if (!s || !vcl_session_is_open (s))
2326 vcl_fifo_rx_evt_valid_or_break (s);
2327 if (sid < n_bits && read_map)
2329 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2333 case SESSION_IO_EVT_TX:
2334 sid = e->session_index;
2335 s = vcl_session_get (wrk, sid);
2336 if (!s || !vcl_session_is_open (s))
2338 if (sid < n_bits && write_map)
2340 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2344 case SESSION_CTRL_EVT_ACCEPTED:
2346 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
2348 s = vcl_session_get (wrk, e->session_index);
2351 sid = s->session_index;
2352 if (sid < n_bits && read_map)
2354 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2358 case SESSION_CTRL_EVT_CONNECTED:
2361 connected_msg = (session_connected_msg_t *) e->data;
2362 sid = vcl_session_connected_handler (wrk, connected_msg);
2365 sid = e->session_index;
2366 if (sid == VCL_INVALID_SESSION_INDEX)
2368 if (sid < n_bits && write_map)
2370 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2374 case SESSION_CTRL_EVT_DISCONNECTED:
2375 disconnected_msg = (session_disconnected_msg_t *) e->data;
2376 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
2379 sid = s->session_index;
2380 if (sid < n_bits && except_map)
2382 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2386 case SESSION_CTRL_EVT_RESET:
2387 sid = vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
2388 if (sid < n_bits && except_map)
2390 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2394 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
2395 vcl_session_unlisten_reply_handler (wrk, e->data);
2397 case SESSION_CTRL_EVT_MIGRATED:
2398 vcl_session_migrated_handler (wrk, e->data);
2400 case SESSION_CTRL_EVT_CLEANUP:
2401 vcl_session_cleanup_handler (wrk, e->data);
2403 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
2404 vcl_session_worker_update_reply_handler (wrk, e->data);
2406 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
2407 vcl_session_req_worker_update_handler (wrk, e->data);
2409 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
2410 vcl_session_app_add_segment_handler (wrk, e->data);
2412 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
2413 vcl_session_app_del_segment_handler (wrk, e->data);
2415 case SESSION_CTRL_EVT_APP_WRK_RPC:
2416 vcl_worker_rpc_handler (wrk, e->data);
2419 clib_warning ("unhandled: %u", e->event_type);
2425 vcl_select_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
2426 unsigned long n_bits, unsigned long *read_map,
2427 unsigned long *write_map, unsigned long *except_map,
2428 double time_to_wait, u32 * bits_set)
2430 svm_msg_q_msg_t *msg;
2434 if (svm_msg_q_is_empty (mq))
2441 else if (time_to_wait < 0)
2442 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2445 if (svm_msg_q_timedwait (mq, time_to_wait))
2449 vcl_mq_dequeue_batch (wrk, mq, ~0);
2451 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
2453 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
2454 e = svm_msg_q_msg_data (mq, msg);
2455 vcl_select_handle_mq_event (wrk, e, n_bits, read_map, write_map,
2456 except_map, bits_set);
2457 svm_msg_q_free_msg (mq, msg);
2459 vec_reset_length (wrk->mq_msg_vector);
2460 vcl_handle_pending_wrk_updates (wrk);
2465 vppcom_select_condvar (vcl_worker_t * wrk, int n_bits,
2466 vcl_si_set * read_map, vcl_si_set * write_map,
2467 vcl_si_set * except_map, double time_to_wait,
2470 double wait = 0, start = 0;
2474 wait = time_to_wait;
2475 start = clib_time_now (&wrk->clib_time);
2480 vcl_select_handle_mq (wrk, wrk->app_event_queue, n_bits, read_map,
2481 write_map, except_map, wait, bits_set);
2487 wait = wait - (clib_time_now (&wrk->clib_time) - start);
2495 vppcom_select_eventfd (vcl_worker_t * wrk, int n_bits,
2496 vcl_si_set * read_map, vcl_si_set * write_map,
2497 vcl_si_set * except_map, double time_to_wait,
2500 vcl_mq_evt_conn_t *mqc;
2501 int __clib_unused n_read;
2505 if (PREDICT_FALSE (wrk->api_client_handle == ~0))
2507 vcl_api_retry_attach (wrk);
2511 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
2512 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
2513 vec_len (wrk->mq_events), time_to_wait);
2514 for (i = 0; i < n_mq_evts; i++)
2516 if (PREDICT_FALSE (wrk->mq_events[i].data.u32 == ~0))
2518 vcl_api_handle_disconnect (wrk);
2522 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
2523 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
2524 vcl_select_handle_mq (wrk, mqc->mq, n_bits, read_map, write_map,
2525 except_map, 0, bits_set);
2528 return (n_mq_evts > 0 ? (int) *bits_set : 0);
2532 vppcom_select (int n_bits, vcl_si_set * read_map, vcl_si_set * write_map,
2533 vcl_si_set * except_map, double time_to_wait)
2535 u32 sid, minbits = clib_max (n_bits, BITS (uword)), bits_set = 0;
2536 vcl_worker_t *wrk = vcl_worker_get_current ();
2537 vcl_session_t *s = 0;
2540 if (n_bits && read_map)
2542 clib_bitmap_validate (wrk->rd_bitmap, minbits);
2543 clib_memcpy_fast (wrk->rd_bitmap, read_map,
2544 vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2545 memset (read_map, 0, vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2547 if (n_bits && write_map)
2549 clib_bitmap_validate (wrk->wr_bitmap, minbits);
2550 clib_memcpy_fast (wrk->wr_bitmap, write_map,
2551 vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2552 memset (write_map, 0, vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2554 if (n_bits && except_map)
2556 clib_bitmap_validate (wrk->ex_bitmap, minbits);
2557 clib_memcpy_fast (wrk->ex_bitmap, except_map,
2558 vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2559 memset (except_map, 0, vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2568 clib_bitmap_foreach (sid, wrk->wr_bitmap)
2570 if (!(s = vcl_session_get (wrk, sid)))
2572 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2577 if (vcl_session_write_ready (s))
2579 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2584 svm_fifo_t *txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2585 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF);
2593 clib_bitmap_foreach (sid, wrk->rd_bitmap)
2595 if (!(s = vcl_session_get (wrk, sid)))
2597 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2602 if (vcl_session_read_ready (s))
2604 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2611 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
2613 vcl_select_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i], n_bits,
2614 read_map, write_map, except_map, &bits_set);
2616 vec_reset_length (wrk->unhandled_evts_vector);
2618 if (vcm->cfg.use_mq_eventfd)
2619 vppcom_select_eventfd (wrk, n_bits, read_map, write_map, except_map,
2620 time_to_wait, &bits_set);
2622 vppcom_select_condvar (wrk, n_bits, read_map, write_map, except_map,
2623 time_to_wait, &bits_set);
2629 vep_verify_epoll_chain (vcl_worker_t * wrk, u32 vep_handle)
2631 vppcom_epoll_t *vep;
2632 u32 sh = vep_handle;
2635 if (VPPCOM_DEBUG <= 2)
2638 s = vcl_session_get_w_handle (wrk, vep_handle);
2639 if (PREDICT_FALSE (!s))
2641 VDBG (0, "ERROR: Invalid vep_sh (%u)!", vep_handle);
2644 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP)))
2646 VDBG (0, "ERROR: vep_sh (%u) is not a vep!", vep_handle);
2650 VDBG (0, "vep_sh (%u): Dumping epoll chain\n"
2653 " is_vep_session = %u\n"
2654 " next_sh = 0x%x (%u)\n"
2655 "}\n", vep_handle, s->flags & VCL_SESSION_F_IS_VEP,
2656 s->flags & VCL_SESSION_F_IS_VEP_SESSION, vep->next_sh, vep->next_sh);
2658 for (sh = vep->next_sh; sh != ~0; sh = vep->next_sh)
2660 s = vcl_session_get_w_handle (wrk, sh);
2661 if (PREDICT_FALSE (!s))
2663 VDBG (0, "ERROR: Invalid sh (%u)!", sh);
2666 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2668 VDBG (0, "ERROR: sh (%u) is a vep!", vep_handle);
2670 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2672 VDBG (0, "ERROR: sh (%u) is not a vep session handle!", sh);
2676 if (PREDICT_FALSE (vep->vep_sh != vep_handle))
2677 VDBG (0, "ERROR: session (%u) vep_sh (%u) != vep_sh (%u)!",
2678 sh, s->vep.vep_sh, vep_handle);
2679 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2681 VDBG (0, "vep_sh[%u]: sh 0x%x (%u)\n"
2683 " next_sh = 0x%x (%u)\n"
2684 " prev_sh = 0x%x (%u)\n"
2685 " vep_sh = 0x%x (%u)\n"
2686 " ev.events = 0x%x\n"
2687 " ev.data.u64 = 0x%llx\n"
2690 vep_handle, sh, sh, vep->next_sh, vep->next_sh, vep->prev_sh,
2691 vep->prev_sh, vep->vep_sh, vep->vep_sh, vep->ev.events,
2692 vep->ev.data.u64, vep->et_mask);
2697 VDBG (0, "vep_sh (%u): Dump complete!\n", vep_handle);
2701 vppcom_epoll_create (void)
2703 vcl_worker_t *wrk = vcl_worker_get_current ();
2704 vcl_session_t *vep_session;
2706 vep_session = vcl_session_alloc (wrk);
2708 vep_session->flags |= VCL_SESSION_F_IS_VEP;
2709 vep_session->vep.vep_sh = ~0;
2710 vep_session->vep.next_sh = ~0;
2711 vep_session->vep.prev_sh = ~0;
2712 vep_session->vpp_handle = ~0;
2714 vcl_evt (VCL_EVT_EPOLL_CREATE, vep_session, vep_session->session_index);
2715 VDBG (0, "Created vep_idx %u", vep_session->session_index);
2717 return vcl_session_handle (vep_session);
2721 vppcom_epoll_ctl (uint32_t vep_handle, int op, uint32_t session_handle,
2722 struct epoll_event *event)
2724 vcl_worker_t *wrk = vcl_worker_get_current ();
2725 int rv = VPPCOM_OK, add_evt = 0;
2726 vcl_session_t *vep_session;
2730 if (vep_handle == session_handle)
2732 VDBG (0, "vep_sh == session handle (%u)!", vep_handle);
2733 return VPPCOM_EINVAL;
2736 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
2737 if (PREDICT_FALSE (!vep_session))
2739 VDBG (0, "Invalid vep_sh (%u)!", vep_handle);
2740 return VPPCOM_EBADFD;
2742 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
2744 VDBG (0, "vep_sh (%u) is not a vep!", vep_handle);
2745 return VPPCOM_EINVAL;
2748 ASSERT (vep_session->vep.vep_sh == ~0);
2749 ASSERT (vep_session->vep.prev_sh == ~0);
2751 s = vcl_session_get_w_handle (wrk, session_handle);
2752 if (PREDICT_FALSE (!s))
2754 VDBG (0, "Invalid session_handle (%u)!", session_handle);
2755 return VPPCOM_EBADFD;
2757 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2759 VDBG (0, "session_handle (%u) is a vep!", vep_handle);
2760 return VPPCOM_EINVAL;
2766 if (PREDICT_FALSE (!event))
2768 VDBG (0, "EPOLL_CTL_ADD: NULL pointer to epoll_event structure!");
2769 return VPPCOM_EINVAL;
2771 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2773 VDBG (0, "EPOLL_CTL_ADD: %u already epolled!", s->session_index);
2777 if (vep_session->vep.next_sh != ~0)
2779 vcl_session_t *next_session;
2780 next_session = vcl_session_get_w_handle (wrk,
2781 vep_session->vep.next_sh);
2782 if (PREDICT_FALSE (!next_session))
2784 VDBG (0, "EPOLL_CTL_ADD: Invalid vep.next_sh (%u) on "
2785 "vep_idx (%u)!", vep_session->vep.next_sh, vep_handle);
2786 return VPPCOM_EBADFD;
2788 ASSERT (next_session->vep.prev_sh == vep_handle);
2789 next_session->vep.prev_sh = session_handle;
2791 s->vep.next_sh = vep_session->vep.next_sh;
2792 s->vep.prev_sh = vep_handle;
2793 s->vep.vep_sh = vep_handle;
2794 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2795 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
2797 s->flags &= ~VCL_SESSION_F_IS_VEP;
2798 s->flags |= VCL_SESSION_F_IS_VEP_SESSION;
2799 vep_session->vep.next_sh = session_handle;
2801 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2802 if (txf && (event->events & EPOLLOUT))
2803 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2805 /* Generate EPOLLOUT if tx fifo not full */
2806 if ((event->events & EPOLLOUT) && (vcl_session_write_ready (s) > 0))
2808 session_event_t e = { 0 };
2809 e.event_type = SESSION_IO_EVT_TX;
2810 e.session_index = s->session_index;
2811 vec_add1 (wrk->unhandled_evts_vector, e);
2814 /* Generate EPOLLIN if rx fifo has data */
2815 if ((event->events & EPOLLIN) && (vcl_session_read_ready (s) > 0))
2817 session_event_t e = { 0 };
2818 e.event_type = SESSION_IO_EVT_RX;
2819 e.session_index = s->session_index;
2820 vec_add1 (wrk->unhandled_evts_vector, e);
2821 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2824 if (!add_evt && vcl_session_is_closing (s))
2826 session_event_t e = { 0 };
2827 if (s->session_state == VCL_STATE_VPP_CLOSING)
2828 e.event_type = SESSION_CTRL_EVT_DISCONNECTED;
2830 e.event_type = SESSION_CTRL_EVT_RESET;
2831 e.session_index = s->session_index;
2833 vec_add1 (wrk->unhandled_evts_vector, e);
2835 VDBG (1, "EPOLL_CTL_ADD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2836 vep_handle, session_handle, event->events, event->data.u64);
2837 vcl_evt (VCL_EVT_EPOLL_CTLADD, s, event->events, event->data.u64);
2841 if (PREDICT_FALSE (!event))
2843 VDBG (0, "EPOLL_CTL_MOD: NULL pointer to epoll_event structure!");
2847 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2849 VDBG (0, "sh %u EPOLL_CTL_MOD: not a vep session!", session_handle);
2853 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2855 VDBG (0, "EPOLL_CTL_MOD: sh %u vep_sh (%u) != vep_sh (%u)!",
2856 session_handle, s->vep.vep_sh, vep_handle);
2861 /* Generate EPOLLOUT if session write ready nd event was not on */
2862 if ((event->events & EPOLLOUT) && !(s->vep.ev.events & EPOLLOUT) &&
2863 (vcl_session_write_ready (s) > 0))
2865 session_event_t e = { 0 };
2866 e.event_type = SESSION_IO_EVT_TX;
2867 e.session_index = s->session_index;
2868 vec_add1 (wrk->unhandled_evts_vector, e);
2870 /* Generate EPOLLIN if session read ready and event was not on */
2871 if ((event->events & EPOLLIN) && !(s->vep.ev.events & EPOLLIN) &&
2872 (vcl_session_read_ready (s) > 0))
2874 session_event_t e = { 0 };
2875 e.event_type = SESSION_IO_EVT_RX;
2876 e.session_index = s->session_index;
2877 vec_add1 (wrk->unhandled_evts_vector, e);
2878 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2880 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2882 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2885 if (event->events & EPOLLOUT)
2886 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2888 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2890 VDBG (1, "EPOLL_CTL_MOD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2891 vep_handle, session_handle, event->events, event->data.u64);
2895 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2897 VDBG (0, "EPOLL_CTL_DEL: %u not a vep session!", session_handle);
2901 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2903 VDBG (0, "EPOLL_CTL_DEL: sh %u vep_sh (%u) != vep_sh (%u)!",
2904 session_handle, s->vep.vep_sh, vep_handle);
2909 if (s->vep.prev_sh == vep_handle)
2910 vep_session->vep.next_sh = s->vep.next_sh;
2913 vcl_session_t *prev_session;
2914 prev_session = vcl_session_get_w_handle (wrk, s->vep.prev_sh);
2915 if (PREDICT_FALSE (!prev_session))
2917 VDBG (0, "EPOLL_CTL_DEL: Invalid prev_sh (%u) on sh (%u)!",
2918 s->vep.prev_sh, session_handle);
2919 return VPPCOM_EBADFD;
2921 ASSERT (prev_session->vep.next_sh == session_handle);
2922 prev_session->vep.next_sh = s->vep.next_sh;
2924 if (s->vep.next_sh != ~0)
2926 vcl_session_t *next_session;
2927 next_session = vcl_session_get_w_handle (wrk, s->vep.next_sh);
2928 if (PREDICT_FALSE (!next_session))
2930 VDBG (0, "EPOLL_CTL_DEL: Invalid next_sh (%u) on sh (%u)!",
2931 s->vep.next_sh, session_handle);
2932 return VPPCOM_EBADFD;
2934 ASSERT (next_session->vep.prev_sh == session_handle);
2935 next_session->vep.prev_sh = s->vep.prev_sh;
2938 if (s->vep.lt_next != VCL_INVALID_SESSION_INDEX)
2939 vcl_epoll_lt_del (wrk, s);
2941 memset (&s->vep, 0, sizeof (s->vep));
2942 s->vep.next_sh = ~0;
2943 s->vep.prev_sh = ~0;
2945 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
2946 s->flags &= ~VCL_SESSION_F_IS_VEP_SESSION;
2948 if (vcl_session_is_open (s))
2950 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2952 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2955 VDBG (1, "EPOLL_CTL_DEL: vep_idx %u, sh %u!", vep_handle,
2957 vcl_evt (VCL_EVT_EPOLL_CTLDEL, s, vep_sh);
2961 VDBG (0, "Invalid operation (%d)!", op);
2965 vep_verify_epoll_chain (wrk, vep_handle);
2972 vcl_epoll_wait_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2973 struct epoll_event *events, u32 * num_ev)
2975 session_disconnected_msg_t *disconnected_msg;
2976 session_connected_msg_t *connected_msg;
2977 u32 sid = ~0, session_events;
2978 u64 session_evt_data = ~0;
2982 switch (e->event_type)
2984 case SESSION_IO_EVT_RX:
2985 sid = e->session_index;
2986 s = vcl_session_get (wrk, sid);
2987 if (vcl_session_is_closed (s))
2989 vcl_fifo_rx_evt_valid_or_break (s);
2990 session_events = s->vep.ev.events;
2991 if (!(EPOLLIN & s->vep.ev.events) ||
2992 (s->flags & VCL_SESSION_F_HAS_RX_EVT) ||
2993 (s->vep.lt_next != VCL_INVALID_SESSION_INDEX))
2996 events[*num_ev].events = EPOLLIN;
2997 session_evt_data = s->vep.ev.data.u64;
2998 s->flags |= VCL_SESSION_F_HAS_RX_EVT;
3000 case SESSION_IO_EVT_TX:
3001 sid = e->session_index;
3002 s = vcl_session_get (wrk, sid);
3003 if (!s || !vcl_session_is_open (s))
3005 session_events = s->vep.ev.events;
3006 if (!(EPOLLOUT & session_events))
3009 events[*num_ev].events = EPOLLOUT;
3010 session_evt_data = s->vep.ev.data.u64;
3011 svm_fifo_reset_has_deq_ntf (vcl_session_is_ct (s) ?
3012 s->ct_tx_fifo : s->tx_fifo);
3014 case SESSION_CTRL_EVT_ACCEPTED:
3016 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
3018 s = vcl_session_get (wrk, e->session_index);
3021 session_events = s->vep.ev.events;
3022 sid = s->session_index;
3023 if (!(EPOLLIN & session_events) ||
3024 (s->vep.lt_next != VCL_INVALID_SESSION_INDEX))
3027 events[*num_ev].events = EPOLLIN;
3028 session_evt_data = s->vep.ev.data.u64;
3030 case SESSION_CTRL_EVT_CONNECTED:
3033 connected_msg = (session_connected_msg_t *) e->data;
3034 sid = vcl_session_connected_handler (wrk, connected_msg);
3037 sid = e->session_index;
3038 s = vcl_session_get (wrk, sid);
3039 if (vcl_session_is_closed (s))
3041 session_events = s->vep.ev.events;
3042 /* Generate EPOLLOUT because there's no connected event */
3043 if (!(EPOLLOUT & session_events))
3046 events[*num_ev].events = EPOLLOUT;
3047 session_evt_data = s->vep.ev.data.u64;
3048 if (s->session_state == VCL_STATE_DETACHED)
3049 events[*num_ev].events |= EPOLLHUP;
3051 case SESSION_CTRL_EVT_DISCONNECTED:
3054 disconnected_msg = (session_disconnected_msg_t *) e->data;
3055 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
3059 s = vcl_session_get (wrk, e->session_index);
3060 s->flags &= ~VCL_SESSION_F_PENDING_DISCONNECT;
3062 if (vcl_session_is_closed (s) ||
3063 !(s->flags & VCL_SESSION_F_IS_VEP_SESSION))
3065 if (s && (s->flags & VCL_SESSION_F_PENDING_FREE))
3066 vcl_session_free (wrk, s);
3069 sid = s->session_index;
3070 session_events = s->vep.ev.events;
3072 if (EPOLLRDHUP & session_events)
3074 /* If app can distinguish between RDHUP and HUP,
3075 * we make finer control */
3076 events[*num_ev].events = EPOLLRDHUP;
3077 if (s->flags & VCL_SESSION_F_WR_SHUTDOWN)
3079 events[*num_ev].events |= EPOLLHUP;
3084 events[*num_ev].events = EPOLLHUP;
3086 session_evt_data = s->vep.ev.data.u64;
3089 case SESSION_CTRL_EVT_RESET:
3093 vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
3094 s = vcl_session_get (wrk, sid);
3098 sid = e->session_index;
3099 s = vcl_session_get (wrk, sid);
3100 s->flags &= ~VCL_SESSION_F_PENDING_DISCONNECT;
3102 if (vcl_session_is_closed (s) ||
3103 !(s->flags & VCL_SESSION_F_IS_VEP_SESSION))
3105 if (s && (s->flags & VCL_SESSION_F_PENDING_FREE))
3106 vcl_session_free (wrk, s);
3109 session_events = s->vep.ev.events;
3111 events[*num_ev].events = EPOLLHUP | EPOLLRDHUP;
3112 session_evt_data = s->vep.ev.data.u64;
3114 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
3115 vcl_session_unlisten_reply_handler (wrk, e->data);
3117 case SESSION_CTRL_EVT_MIGRATED:
3118 vcl_session_migrated_handler (wrk, e->data);
3120 case SESSION_CTRL_EVT_CLEANUP:
3121 vcl_session_cleanup_handler (wrk, e->data);
3123 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
3124 vcl_session_req_worker_update_handler (wrk, e->data);
3126 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
3127 vcl_session_worker_update_reply_handler (wrk, e->data);
3129 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
3130 vcl_session_app_add_segment_handler (wrk, e->data);
3132 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
3133 vcl_session_app_del_segment_handler (wrk, e->data);
3135 case SESSION_CTRL_EVT_APP_WRK_RPC:
3136 vcl_worker_rpc_handler (wrk, e->data);
3139 VDBG (0, "unhandled: %u", e->event_type);
3145 events[*num_ev].data.u64 = session_evt_data;
3146 if (EPOLLONESHOT & session_events)
3148 s = vcl_session_get (wrk, sid);
3149 s->vep.ev.events = 0;
3151 else if (!(EPOLLET & session_events))
3153 s = vcl_session_get (wrk, sid);
3154 if (s->vep.lt_next == VCL_INVALID_SESSION_INDEX)
3155 vcl_epoll_lt_add (wrk, s);
3162 vcl_epoll_wait_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
3163 struct epoll_event *events, u32 maxevents,
3164 double wait_for_time, u32 * num_ev)
3166 svm_msg_q_msg_t *msg;
3170 if (vec_len (wrk->mq_msg_vector) && svm_msg_q_is_empty (mq))
3171 goto handle_dequeued;
3173 if (svm_msg_q_is_empty (mq))
3177 else if (wait_for_time < 0)
3178 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
3181 if (svm_msg_q_timedwait (mq, wait_for_time / 1e3))
3185 ASSERT (maxevents > *num_ev);
3186 vcl_mq_dequeue_batch (wrk, mq, ~0);
3189 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
3191 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
3192 e = svm_msg_q_msg_data (mq, msg);
3193 if (*num_ev < maxevents)
3194 vcl_epoll_wait_handle_mq_event (wrk, e, events, num_ev);
3196 vcl_handle_mq_event (wrk, e);
3197 svm_msg_q_free_msg (mq, msg);
3199 vec_reset_length (wrk->mq_msg_vector);
3200 vcl_handle_pending_wrk_updates (wrk);
3205 vppcom_epoll_wait_condvar (vcl_worker_t *wrk, struct epoll_event *events,
3206 int maxevents, u32 n_evts, double timeout_ms)
3213 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3218 vcl_epoll_wait_handle_mq (wrk, wrk->app_event_queue, events, maxevents,
3219 timeout_ms, &n_evts);
3220 if (n_evts || !timeout_ms)
3223 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3229 vppcom_epoll_wait_eventfd (vcl_worker_t *wrk, struct epoll_event *events,
3230 int maxevents, u32 n_evts, double timeout_ms)
3232 int __clib_unused n_read;
3233 vcl_mq_evt_conn_t *mqc;
3238 if (PREDICT_FALSE (wrk->api_client_handle == ~0))
3240 vcl_api_retry_attach (wrk);
3244 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
3248 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3253 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
3254 vec_len (wrk->mq_events), timeout_ms);
3257 VDBG (0, "epoll_wait error %u", errno);
3261 for (i = 0; i < n_mq_evts; i++)
3263 if (PREDICT_FALSE (wrk->mq_events[i].data.u32 == ~0))
3265 /* api socket was closed */
3266 vcl_api_handle_disconnect (wrk);
3270 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
3271 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
3272 vcl_epoll_wait_handle_mq (wrk, mqc->mq, events, maxevents, 0,
3276 if (n_evts || !timeout_ms)
3279 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3285 vcl_epoll_wait_handle_lt (vcl_worker_t *wrk, struct epoll_event *events,
3286 int maxevents, u32 *n_evts)
3288 u32 add_event = 0, next;
3293 ASSERT (wrk->ep_lt_current != VCL_INVALID_SESSION_INDEX);
3294 if (*n_evts >= maxevents)
3297 next = wrk->ep_lt_current;
3300 s = vcl_session_get (wrk, next);
3301 next = s->vep.lt_next;
3303 if ((s->vep.ev.events & EPOLLIN) && (rv = vcl_session_read_ready (s)))
3306 events[*n_evts].events |= rv > 0 ? EPOLLIN : EPOLLHUP | EPOLLRDHUP;
3307 evt_data = s->vep.ev.data.u64;
3309 if ((s->vep.ev.events & EPOLLOUT) && (rv = vcl_session_write_ready (s)))
3312 events[*n_evts].events |= rv > 0 ? EPOLLOUT : EPOLLHUP | EPOLLRDHUP;
3313 evt_data = s->vep.ev.data.u64;
3315 if (!add_event && s->session_state > VCL_STATE_READY)
3318 events[*n_evts].events |= EPOLLHUP | EPOLLRDHUP;
3319 evt_data = s->vep.ev.data.u64;
3323 events[*n_evts].data.u64 = evt_data;
3326 if (EPOLLONESHOT & s->vep.ev.events)
3327 s->vep.ev.events = 0;
3328 if (*n_evts == maxevents)
3330 wrk->ep_lt_current = next;
3336 vcl_epoll_lt_del (wrk, s);
3337 if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX)
3341 while (next != wrk->ep_lt_current);
3345 vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
3346 int maxevents, double wait_for_time)
3348 vcl_worker_t *wrk = vcl_worker_get_current ();
3349 vcl_session_t *vep_session;
3353 if (PREDICT_FALSE (maxevents <= 0))
3355 VDBG (0, "ERROR: Invalid maxevents (%d)!", maxevents);
3356 return VPPCOM_EINVAL;
3359 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
3361 return VPPCOM_EBADFD;
3363 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
3365 VDBG (0, "ERROR: vep_idx (%u) is not a vep!", vep_handle);
3366 return VPPCOM_EINVAL;
3369 if (vec_len (wrk->unhandled_evts_vector))
3371 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
3373 vcl_epoll_wait_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i],
3375 if (n_evts == maxevents)
3377 vec_delete (wrk->unhandled_evts_vector, i + 1, 0);
3381 vec_reset_length (wrk->unhandled_evts_vector);
3384 if (PREDICT_FALSE (wrk->ep_lt_current != VCL_INVALID_SESSION_INDEX))
3385 vcl_epoll_wait_handle_lt (wrk, events, maxevents, &n_evts);
3387 /* Request to only drain unhandled */
3388 if ((int) wait_for_time == -2)
3392 if (vcm->cfg.use_mq_eventfd)
3393 n_evts = vppcom_epoll_wait_eventfd (wrk, events, maxevents, n_evts,
3396 n_evts = vppcom_epoll_wait_condvar (wrk, events, maxevents, n_evts,
3403 vppcom_session_attr (uint32_t session_handle, uint32_t op,
3404 void *buffer, uint32_t * buflen)
3406 vcl_worker_t *wrk = vcl_worker_get_current ();
3407 u32 *flags = buffer;
3408 vppcom_endpt_t *ep = buffer;
3409 transport_endpt_attr_t tea;
3410 vcl_session_t *session;
3413 session = vcl_session_get_w_handle (wrk, session_handle);
3415 return VPPCOM_EBADFD;
3419 case VPPCOM_ATTR_GET_NREAD:
3420 rv = vcl_session_read_ready (session);
3421 VDBG (2, "VPPCOM_ATTR_GET_NREAD: sh %u, nread = %d", session_handle,
3425 case VPPCOM_ATTR_GET_NWRITE:
3426 rv = vcl_session_write_ready (session);
3427 VDBG (2, "VPPCOM_ATTR_GET_NWRITE: sh %u, nwrite = %d", session_handle,
3431 case VPPCOM_ATTR_GET_FLAGS:
3432 if (PREDICT_TRUE (buffer && buflen && (*buflen >= sizeof (*flags))))
3436 (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK) ?
3438 *buflen = sizeof (*flags);
3439 VDBG (2, "VPPCOM_ATTR_GET_FLAGS: sh %u, flags = 0x%08x, "
3440 "is_nonblocking = %u", session_handle, *flags,
3441 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3447 case VPPCOM_ATTR_SET_FLAGS:
3448 if (PREDICT_TRUE (buffer && buflen && (*buflen == sizeof (*flags))))
3450 if (*flags & O_NONBLOCK)
3451 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
3453 vcl_session_clear_attr (session, VCL_SESS_ATTR_NONBLOCK);
3455 VDBG (2, "VPPCOM_ATTR_SET_FLAGS: sh %u, flags = 0x%08x,"
3456 " is_nonblocking = %u", session_handle, *flags,
3457 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3463 case VPPCOM_ATTR_GET_PEER_ADDR:
3464 if (PREDICT_TRUE (buffer && buflen &&
3465 (*buflen >= sizeof (*ep)) && ep->ip))
3467 ep->is_ip4 = session->transport.is_ip4;
3468 ep->port = session->transport.rmt_port;
3469 if (session->transport.is_ip4)
3470 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
3471 sizeof (ip4_address_t));
3473 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
3474 sizeof (ip6_address_t));
3475 *buflen = sizeof (*ep);
3477 "VPPCOM_ATTR_GET_PEER_ADDR: sh %u, is_ip4 = %u, "
3478 "addr = %U, port %u",
3479 session_handle, ep->is_ip4, vcl_format_ip46_address,
3480 &session->transport.rmt_ip,
3481 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3482 clib_net_to_host_u16 (ep->port));
3488 case VPPCOM_ATTR_GET_LCL_ADDR:
3489 if (PREDICT_TRUE (buffer && buflen &&
3490 (*buflen >= sizeof (*ep)) && ep->ip))
3492 ep->is_ip4 = session->transport.is_ip4;
3493 ep->port = session->transport.lcl_port;
3494 if (session->transport.is_ip4)
3495 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip4,
3496 sizeof (ip4_address_t));
3498 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip6,
3499 sizeof (ip6_address_t));
3500 *buflen = sizeof (*ep);
3502 "VPPCOM_ATTR_GET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3504 session_handle, ep->is_ip4, vcl_format_ip46_address,
3505 &session->transport.lcl_ip,
3506 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3507 clib_net_to_host_u16 (ep->port));
3513 case VPPCOM_ATTR_SET_LCL_ADDR:
3514 if (PREDICT_TRUE (buffer && buflen &&
3515 (*buflen >= sizeof (*ep)) && ep->ip))
3517 session->transport.is_ip4 = ep->is_ip4;
3518 session->transport.lcl_port = ep->port;
3519 vcl_ip_copy_from_ep (&session->transport.lcl_ip, ep);
3520 *buflen = sizeof (*ep);
3522 "VPPCOM_ATTR_SET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3524 session_handle, ep->is_ip4, vcl_format_ip46_address,
3525 &session->transport.lcl_ip,
3526 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3527 clib_net_to_host_u16 (ep->port));
3533 case VPPCOM_ATTR_GET_LIBC_EPFD:
3534 rv = session->libc_epfd;
3535 VDBG (2, "VPPCOM_ATTR_GET_LIBC_EPFD: libc_epfd %d", rv);
3538 case VPPCOM_ATTR_SET_LIBC_EPFD:
3539 if (PREDICT_TRUE (buffer && buflen &&
3540 (*buflen == sizeof (session->libc_epfd))))
3542 session->libc_epfd = *(int *) buffer;
3543 *buflen = sizeof (session->libc_epfd);
3545 VDBG (2, "VPPCOM_ATTR_SET_LIBC_EPFD: libc_epfd %d, buflen %d",
3546 session->libc_epfd, *buflen);
3552 case VPPCOM_ATTR_GET_PROTOCOL:
3553 if (buffer && buflen && (*buflen >= sizeof (int)))
3555 *(int *) buffer = session->session_type;
3556 *buflen = sizeof (int);
3558 VDBG (2, "VPPCOM_ATTR_GET_PROTOCOL: %d (%s), buflen %d",
3559 *(int *) buffer, *(int *) buffer ? "UDP" : "TCP", *buflen);
3565 case VPPCOM_ATTR_GET_LISTEN:
3566 if (buffer && buflen && (*buflen >= sizeof (int)))
3568 *(int *) buffer = vcl_session_has_attr (session,
3569 VCL_SESS_ATTR_LISTEN);
3570 *buflen = sizeof (int);
3572 VDBG (2, "VPPCOM_ATTR_GET_LISTEN: %d, buflen %d", *(int *) buffer,
3579 case VPPCOM_ATTR_GET_ERROR:
3580 if (buffer && buflen && (*buflen >= sizeof (int)))
3582 *(int *) buffer = 0;
3583 *buflen = sizeof (int);
3585 VDBG (2, "VPPCOM_ATTR_GET_ERROR: %d, buflen %d, #VPP-TBD#",
3586 *(int *) buffer, *buflen);
3592 case VPPCOM_ATTR_GET_TX_FIFO_LEN:
3593 if (buffer && buflen && (*buflen >= sizeof (u32)))
3597 *(size_t *) buffer = (session->sndbuf_size ? session->sndbuf_size :
3599 svm_fifo_size (session->tx_fifo) :
3600 vcm->cfg.tx_fifo_size);
3601 *buflen = sizeof (u32);
3603 VDBG (2, "VPPCOM_ATTR_GET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3604 " #VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer,
3611 case VPPCOM_ATTR_SET_DSCP:
3612 if (buffer && buflen && (*buflen >= sizeof (u8)))
3614 session->dscp = *(u8 *) buffer;
3616 VDBG (2, "VPPCOM_ATTR_SET_DSCP: %u (0x%x), buflen %d,",
3617 *(u8 *) buffer, *(u8 *) buffer, *buflen);
3623 case VPPCOM_ATTR_SET_TX_FIFO_LEN:
3624 if (buffer && buflen && (*buflen == sizeof (u32)))
3627 session->sndbuf_size = *(u32 *) buffer;
3628 VDBG (2, "VPPCOM_ATTR_SET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3629 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3636 case VPPCOM_ATTR_GET_RX_FIFO_LEN:
3637 if (buffer && buflen && (*buflen >= sizeof (u32)))
3641 *(size_t *) buffer = (session->rcvbuf_size ? session->rcvbuf_size :
3643 svm_fifo_size (session->rx_fifo) :
3644 vcm->cfg.rx_fifo_size);
3645 *buflen = sizeof (u32);
3647 VDBG (2, "VPPCOM_ATTR_GET_RX_FIFO_LEN: %u (0x%x), buflen %d, "
3648 "#VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer, *buflen);
3654 case VPPCOM_ATTR_SET_RX_FIFO_LEN:
3655 if (buffer && buflen && (*buflen == sizeof (u32)))
3658 session->rcvbuf_size = *(u32 *) buffer;
3659 VDBG (2, "VPPCOM_ATTR_SET_RX_FIFO_LEN: %u (0x%x), buflen %d,"
3660 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3667 case VPPCOM_ATTR_GET_REUSEADDR:
3668 if (buffer && buflen && (*buflen >= sizeof (int)))
3671 *(int *) buffer = vcl_session_has_attr (session,
3672 VCL_SESS_ATTR_REUSEADDR);
3673 *buflen = sizeof (int);
3675 VDBG (2, "VPPCOM_ATTR_GET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3676 *(int *) buffer, *buflen);
3682 case VPPCOM_ATTR_SET_REUSEADDR:
3683 if (buffer && buflen && (*buflen == sizeof (int)) &&
3684 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3687 if (*(int *) buffer)
3688 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEADDR);
3690 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEADDR);
3692 VDBG (2, "VPPCOM_ATTR_SET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3693 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEADDR),
3700 case VPPCOM_ATTR_GET_REUSEPORT:
3701 if (buffer && buflen && (*buflen >= sizeof (int)))
3704 *(int *) buffer = vcl_session_has_attr (session,
3705 VCL_SESS_ATTR_REUSEPORT);
3706 *buflen = sizeof (int);
3708 VDBG (2, "VPPCOM_ATTR_GET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3709 *(int *) buffer, *buflen);
3715 case VPPCOM_ATTR_SET_REUSEPORT:
3716 if (buffer && buflen && (*buflen == sizeof (int)) &&
3717 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3720 if (*(int *) buffer)
3721 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEPORT);
3723 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEPORT);
3725 VDBG (2, "VPPCOM_ATTR_SET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3726 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEPORT),
3733 case VPPCOM_ATTR_GET_BROADCAST:
3734 if (buffer && buflen && (*buflen >= sizeof (int)))
3737 *(int *) buffer = vcl_session_has_attr (session,
3738 VCL_SESS_ATTR_BROADCAST);
3739 *buflen = sizeof (int);
3741 VDBG (2, "VPPCOM_ATTR_GET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3742 *(int *) buffer, *buflen);
3748 case VPPCOM_ATTR_SET_BROADCAST:
3749 if (buffer && buflen && (*buflen == sizeof (int)))
3752 if (*(int *) buffer)
3753 vcl_session_set_attr (session, VCL_SESS_ATTR_BROADCAST);
3755 vcl_session_clear_attr (session, VCL_SESS_ATTR_BROADCAST);
3757 VDBG (2, "VPPCOM_ATTR_SET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3758 vcl_session_has_attr (session, VCL_SESS_ATTR_BROADCAST),
3765 case VPPCOM_ATTR_GET_V6ONLY:
3766 if (buffer && buflen && (*buflen >= sizeof (int)))
3769 *(int *) buffer = vcl_session_has_attr (session,
3770 VCL_SESS_ATTR_V6ONLY);
3771 *buflen = sizeof (int);
3773 VDBG (2, "VPPCOM_ATTR_GET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3774 *(int *) buffer, *buflen);
3780 case VPPCOM_ATTR_SET_V6ONLY:
3781 if (buffer && buflen && (*buflen == sizeof (int)))
3784 if (*(int *) buffer)
3785 vcl_session_set_attr (session, VCL_SESS_ATTR_V6ONLY);
3787 vcl_session_clear_attr (session, VCL_SESS_ATTR_V6ONLY);
3789 VDBG (2, "VPPCOM_ATTR_SET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3790 vcl_session_has_attr (session, VCL_SESS_ATTR_V6ONLY),
3797 case VPPCOM_ATTR_GET_KEEPALIVE:
3798 if (buffer && buflen && (*buflen >= sizeof (int)))
3801 *(int *) buffer = vcl_session_has_attr (session,
3802 VCL_SESS_ATTR_KEEPALIVE);
3803 *buflen = sizeof (int);
3805 VDBG (2, "VPPCOM_ATTR_GET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3806 *(int *) buffer, *buflen);
3812 case VPPCOM_ATTR_SET_KEEPALIVE:
3813 if (buffer && buflen && (*buflen == sizeof (int)))
3816 if (*(int *) buffer)
3817 vcl_session_set_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3819 vcl_session_clear_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3821 VDBG (2, "VPPCOM_ATTR_SET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3822 vcl_session_has_attr (session, VCL_SESS_ATTR_KEEPALIVE),
3829 case VPPCOM_ATTR_GET_TCP_NODELAY:
3830 if (buffer && buflen && (*buflen >= sizeof (int)))
3833 *(int *) buffer = vcl_session_has_attr (session,
3834 VCL_SESS_ATTR_TCP_NODELAY);
3835 *buflen = sizeof (int);
3837 VDBG (2, "VPPCOM_ATTR_GET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3838 *(int *) buffer, *buflen);
3844 case VPPCOM_ATTR_SET_TCP_NODELAY:
3845 if (buffer && buflen && (*buflen == sizeof (int)))
3848 if (*(int *) buffer)
3849 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3851 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3853 VDBG (2, "VPPCOM_ATTR_SET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3854 vcl_session_has_attr (session, VCL_SESS_ATTR_TCP_NODELAY),
3861 case VPPCOM_ATTR_GET_TCP_KEEPIDLE:
3862 if (buffer && buflen && (*buflen >= sizeof (int)))
3865 *(int *) buffer = vcl_session_has_attr (session,
3866 VCL_SESS_ATTR_TCP_KEEPIDLE);
3867 *buflen = sizeof (int);
3869 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3870 *(int *) buffer, *buflen);
3876 case VPPCOM_ATTR_SET_TCP_KEEPIDLE:
3877 if (buffer && buflen && (*buflen == sizeof (int)))
3880 if (*(int *) buffer)
3881 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3883 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3885 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3886 vcl_session_has_attr (session,
3887 VCL_SESS_ATTR_TCP_KEEPIDLE), *buflen);
3893 case VPPCOM_ATTR_GET_TCP_KEEPINTVL:
3894 if (buffer && buflen && (*buflen >= sizeof (int)))
3897 *(int *) buffer = vcl_session_has_attr (session,
3898 VCL_SESS_ATTR_TCP_KEEPINTVL);
3899 *buflen = sizeof (int);
3901 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3902 *(int *) buffer, *buflen);
3908 case VPPCOM_ATTR_SET_TCP_KEEPINTVL:
3909 if (buffer && buflen && (*buflen == sizeof (int)))
3912 if (*(int *) buffer)
3913 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3915 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3917 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3918 vcl_session_has_attr (session,
3919 VCL_SESS_ATTR_TCP_KEEPINTVL), *buflen);
3925 case VPPCOM_ATTR_GET_TCP_USER_MSS:
3926 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
3932 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3933 tea.mss = *(u32 *) buffer;
3934 if (vcl_session_transport_attr (wrk, session, 1 /* is_get */, &tea))
3935 rv = VPPCOM_ENOPROTOOPT;
3939 *(u32 *) buffer = tea.mss;
3940 *buflen = sizeof (int);
3943 VDBG (2, "VPPCOM_ATTR_GET_TCP_USER_MSS: %d, buflen %d", *(int *) buffer,
3947 case VPPCOM_ATTR_SET_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, 0 /* is_get */, &tea))
3957 rv = VPPCOM_ENOPROTOOPT;
3959 VDBG (2, "VPPCOM_ATTR_SET_TCP_USER_MSS: %u, buflen %d", tea.mss,
3963 case VPPCOM_ATTR_SET_CONNECTED:
3964 session->flags |= VCL_SESSION_F_CONNECTED;
3967 case VPPCOM_ATTR_SET_CKPAIR:
3968 if (!(buffer && buflen && (*buflen == sizeof (int))) ||
3969 !vcl_session_has_crypto (session))
3974 if (!session->ext_config)
3976 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_CRYPTO,
3977 sizeof (transport_endpt_ext_cfg_t));
3979 else if (session->ext_config->type != TRANSPORT_ENDPT_EXT_CFG_CRYPTO)
3985 session->ext_config->crypto.ckpair_index = *(uint32_t *) buffer;
3988 case VPPCOM_ATTR_SET_VRF:
3989 if (!(buffer && buflen && (*buflen == sizeof (u32))))
3994 session->vrf = *(u32 *) buffer;
3997 case VPPCOM_ATTR_GET_VRF:
3998 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
4003 *(u32 *) buffer = session->vrf;
4004 *buflen = sizeof (u32);
4007 case VPPCOM_ATTR_GET_DOMAIN:
4008 if (!(buffer && buflen && (*buflen >= sizeof (int))))
4014 if (session->transport.is_ip4)
4015 *(int *) buffer = AF_INET;
4017 *(int *) buffer = AF_INET6;
4018 *buflen = sizeof (int);
4020 VDBG (2, "VPPCOM_ATTR_GET_DOMAIN: %d, buflen %u", *(int *) buffer,
4024 case VPPCOM_ATTR_SET_ENDPT_EXT_CFG:
4025 if (!(buffer && buflen && (*buflen > 0)))
4030 if (session->ext_config)
4035 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_NONE,
4036 *buflen + sizeof (u32));
4037 clib_memcpy (session->ext_config->data, buffer, *buflen);
4038 session->ext_config->len = *buflen;
4050 vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
4051 uint32_t buflen, int flags, vppcom_endpt_t * ep)
4053 vcl_worker_t *wrk = vcl_worker_get_current ();
4054 vcl_session_t *session;
4058 rv = vppcom_session_read (session_handle, buffer, buflen);
4059 else if (flags & MSG_PEEK)
4060 rv = vppcom_session_peek (session_handle, buffer, buflen);
4063 VDBG (0, "Unsupport flags for recvfrom %d", flags);
4064 return VPPCOM_EAFNOSUPPORT;
4069 session = vcl_session_get_w_handle (wrk, session_handle);
4070 if (session->transport.is_ip4)
4071 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
4072 sizeof (ip4_address_t));
4074 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
4075 sizeof (ip6_address_t));
4076 ep->is_ip4 = session->transport.is_ip4;
4077 ep->port = session->transport.rmt_port;
4084 vppcom_session_sendto (uint32_t session_handle, void *buffer,
4085 uint32_t buflen, int flags, vppcom_endpt_t * ep)
4087 vcl_worker_t *wrk = vcl_worker_get_current ();
4090 s = vcl_session_get_w_handle (wrk, session_handle);
4091 if (PREDICT_FALSE (!s))
4092 return VPPCOM_EBADFD;
4096 if (!vcl_session_is_cl (s))
4097 return VPPCOM_EINVAL;
4099 s->transport.is_ip4 = ep->is_ip4;
4100 s->transport.rmt_port = ep->port;
4101 vcl_ip_copy_from_ep (&s->transport.rmt_ip, ep);
4103 /* Session not connected/bound in vpp. Create it by 'connecting' it */
4104 if (PREDICT_FALSE (s->session_state == VCL_STATE_CLOSED))
4106 u32 session_index = s->session_index;
4107 f64 timeout = vcm->cfg.session_timeout;
4110 vcl_send_session_connect (wrk, s);
4111 rv = vppcom_wait_for_session_state_change (session_index,
4116 s = vcl_session_get (wrk, session_index);
4122 // TBD check the flags and do the right thing
4123 VDBG (2, "handling flags 0x%u (%d) not implemented yet.", flags, flags);
4126 return (vppcom_session_write_inline (wrk, s, buffer, buflen, 1,
4127 s->is_dgram ? 1 : 0));
4131 vppcom_poll (vcl_poll_t * vp, uint32_t n_sids, double wait_for_time)
4133 vcl_worker_t *wrk = vcl_worker_get_current ();
4134 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
4135 u32 i, keep_trying = 1;
4136 svm_msg_q_msg_t msg;
4140 VDBG (3, "vp %p, nsids %u, wait_for_time %f", vp, n_sids, wait_for_time);
4143 return VPPCOM_EFAULT;
4147 vcl_session_t *session;
4149 /* Dequeue all events and drop all unhandled io events */
4150 while (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0) == 0)
4152 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
4153 vcl_handle_mq_event (wrk, e);
4154 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
4156 vec_reset_length (wrk->unhandled_evts_vector);
4158 for (i = 0; i < n_sids; i++)
4160 session = vcl_session_get (wrk, vp[i].sh);
4163 vp[i].revents = POLLHUP;
4170 if (POLLIN & vp[i].events)
4172 rv = vcl_session_read_ready (session);
4175 vp[i].revents |= POLLIN;
4182 case VPPCOM_ECONNRESET:
4183 vp[i].revents = POLLHUP;
4187 vp[i].revents = POLLERR;
4194 if (POLLOUT & vp[i].events)
4196 rv = vcl_session_write_ready (session);
4199 vp[i].revents |= POLLOUT;
4206 case VPPCOM_ECONNRESET:
4207 vp[i].revents = POLLHUP;
4211 vp[i].revents = POLLERR;
4218 if (0) // Note "done:" label used by VCL_SESSION_LOCK_AND_GET()
4220 vp[i].revents = POLLNVAL;
4224 if (wait_for_time != -1)
4225 keep_trying = (clib_time_now (&wrk->clib_time) <= timeout) ? 1 : 0;
4227 while ((num_ev == 0) && keep_trying);
4233 vppcom_mq_epoll_fd (void)
4235 vcl_worker_t *wrk = vcl_worker_get_current ();
4236 return wrk->mqs_epfd;
4240 vppcom_session_index (vcl_session_handle_t session_handle)
4242 return session_handle & 0xFFFFFF;
4246 vppcom_session_worker (vcl_session_handle_t session_handle)
4248 return session_handle >> 24;
4252 vppcom_worker_register (void)
4254 if (!vcl_worker_alloc_and_init ())
4255 return VPPCOM_EEXIST;
4257 if (vcl_worker_register_with_vpp ())
4258 return VPPCOM_EEXIST;
4264 vppcom_worker_unregister (void)
4266 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
4267 vcl_set_worker_index (~0);
4271 vppcom_worker_index_set (int index)
4273 vcl_set_worker_index (index);
4277 vppcom_worker_index (void)
4279 return vcl_get_worker_index ();
4283 vppcom_worker_mqs_epfd (void)
4285 vcl_worker_t *wrk = vcl_worker_get_current ();
4286 if (!vcm->cfg.use_mq_eventfd)
4288 return wrk->mqs_epfd;
4292 vppcom_session_is_connectable_listener (uint32_t session_handle)
4294 vcl_session_t *session;
4295 vcl_worker_t *wrk = vcl_worker_get_current ();
4296 session = vcl_session_get_w_handle (wrk, session_handle);
4298 return VPPCOM_EBADFD;
4299 return vcl_session_is_connectable_listener (wrk, session);
4303 vppcom_session_listener (uint32_t session_handle)
4305 vcl_worker_t *wrk = vcl_worker_get_current ();
4306 vcl_session_t *listen_session, *session;
4307 session = vcl_session_get_w_handle (wrk, session_handle);
4309 return VPPCOM_EBADFD;
4310 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
4311 return VPPCOM_EBADFD;
4312 listen_session = vcl_session_get_w_handle (wrk, session->listener_index);
4313 if (!listen_session)
4314 return VPPCOM_EBADFD;
4315 return vcl_session_handle (listen_session);
4319 vppcom_session_n_accepted (uint32_t session_handle)
4321 vcl_worker_t *wrk = vcl_worker_get_current ();
4322 vcl_session_t *session = vcl_session_get_w_handle (wrk, session_handle);
4324 return VPPCOM_EBADFD;
4325 return session->n_accepted_sessions;
4329 vppcom_proto_str (vppcom_proto_t proto)
4331 char const *proto_str;
4335 case VPPCOM_PROTO_TCP:
4338 case VPPCOM_PROTO_UDP:
4341 case VPPCOM_PROTO_TLS:
4344 case VPPCOM_PROTO_QUIC:
4347 case VPPCOM_PROTO_DTLS:
4350 case VPPCOM_PROTO_SRTP:
4354 proto_str = "UNKNOWN";
4361 vppcom_retval_str (int retval)
4372 st = "VPPCOM_EAGAIN";
4376 st = "VPPCOM_EFAULT";
4380 st = "VPPCOM_ENOMEM";
4384 st = "VPPCOM_EINVAL";
4388 st = "VPPCOM_EBADFD";
4391 case VPPCOM_EAFNOSUPPORT:
4392 st = "VPPCOM_EAFNOSUPPORT";
4395 case VPPCOM_ECONNABORTED:
4396 st = "VPPCOM_ECONNABORTED";
4399 case VPPCOM_ECONNRESET:
4400 st = "VPPCOM_ECONNRESET";
4403 case VPPCOM_ENOTCONN:
4404 st = "VPPCOM_ENOTCONN";
4407 case VPPCOM_ECONNREFUSED:
4408 st = "VPPCOM_ECONNREFUSED";
4411 case VPPCOM_ETIMEDOUT:
4412 st = "VPPCOM_ETIMEDOUT";
4416 st = "UNKNOWN_STATE";
4424 vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
4426 if (vcm->cfg.vpp_app_socket_api)
4427 return vcl_sapi_add_cert_key_pair (ckpair);
4429 return vcl_bapi_add_cert_key_pair (ckpair);
4433 vppcom_del_cert_key_pair (uint32_t ckpair_index)
4435 if (vcm->cfg.vpp_app_socket_api)
4436 return vcl_sapi_del_cert_key_pair (ckpair_index);
4438 return vcl_bapi_del_cert_key_pair (ckpair_index);
4442 * fd.io coding-style-patch-verification: ON
4445 * eval: (c-set-style "gnu")