2 * Copyright (c) 2017-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 #include <vcl/vppcom.h>
19 #include <vcl/vcl_debug.h>
20 #include <vcl/vcl_private.h>
21 #include <svm/fifo_segment.h>
23 __thread uword __vcl_worker_index = ~0;
26 vcl_mq_dequeue_batch (vcl_worker_t * wrk, svm_msg_q_t * mq, u32 n_max_msg)
28 u32 n_msgs = 0, sz, len;
30 while ((sz = svm_msg_q_size (mq)))
32 len = vec_len (wrk->mq_msg_vector);
33 vec_validate (wrk->mq_msg_vector, len + sz - 1);
34 svm_msg_q_sub_raw_batch (mq, wrk->mq_msg_vector + len, sz);
43 vcl_msg_add_ext_config (vcl_session_t *s, uword *offset)
47 c = vcl_segment_alloc_chunk (vcl_vpp_worker_segment_handle (0),
48 0 /* one slice only */, s->ext_config->len,
51 clib_memcpy_fast (c->data, s->ext_config, s->ext_config->len);
55 vcl_send_session_listen (vcl_worker_t * wrk, vcl_session_t * s)
57 app_session_evt_t _app_evt, *app_evt = &_app_evt;
58 session_listen_msg_t *mp;
61 mq = vcl_worker_ctrl_mq (wrk);
62 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_LISTEN);
63 mp = (session_listen_msg_t *) app_evt->evt->data;
64 memset (mp, 0, sizeof (*mp));
65 mp->client_index = wrk->api_client_handle;
66 mp->context = s->session_index;
67 mp->wrk_index = wrk->vpp_wrk_index;
68 mp->is_ip4 = s->transport.is_ip4;
69 clib_memcpy_fast (&mp->ip, &s->transport.lcl_ip, sizeof (mp->ip));
70 mp->port = s->transport.lcl_port;
71 mp->proto = s->session_type;
73 if (s->flags & VCL_SESSION_F_CONNECTED)
74 mp->flags = TRANSPORT_CFG_F_CONNECTED;
76 vcl_msg_add_ext_config (s, &mp->ext_config);
77 app_send_ctrl_evt_to_vpp (mq, app_evt);
80 clib_mem_free (s->ext_config);
86 vcl_send_session_connect (vcl_worker_t * wrk, vcl_session_t * s)
88 app_session_evt_t _app_evt, *app_evt = &_app_evt;
89 session_connect_msg_t *mp;
92 mq = vcl_worker_ctrl_mq (wrk);
93 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_CONNECT);
94 mp = (session_connect_msg_t *) app_evt->evt->data;
95 memset (mp, 0, sizeof (*mp));
96 mp->client_index = wrk->api_client_handle;
97 mp->context = s->session_index;
99 mp->wrk_index = wrk->vpp_wrk_index;
100 mp->is_ip4 = s->transport.is_ip4;
101 mp->parent_handle = s->parent_handle;
102 clib_memcpy_fast (&mp->ip, &s->transport.rmt_ip, sizeof (mp->ip));
103 clib_memcpy_fast (&mp->lcl_ip, &s->transport.lcl_ip, sizeof (mp->lcl_ip));
104 mp->port = s->transport.rmt_port;
105 mp->lcl_port = s->transport.lcl_port;
106 mp->proto = s->session_type;
108 if (s->flags & VCL_SESSION_F_CONNECTED)
109 mp->flags |= TRANSPORT_CFG_F_CONNECTED;
111 vcl_msg_add_ext_config (s, &mp->ext_config);
112 app_send_ctrl_evt_to_vpp (mq, app_evt);
116 clib_mem_free (s->ext_config);
122 vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s)
124 app_session_evt_t _app_evt, *app_evt = &_app_evt;
125 session_unlisten_msg_t *mp;
128 mq = vcl_worker_ctrl_mq (wrk);
129 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_UNLISTEN);
130 mp = (session_unlisten_msg_t *) app_evt->evt->data;
131 memset (mp, 0, sizeof (*mp));
132 mp->client_index = wrk->api_client_handle;
133 mp->wrk_index = wrk->vpp_wrk_index;
134 mp->handle = s->vpp_handle;
135 mp->context = wrk->wrk_index;
136 app_send_ctrl_evt_to_vpp (mq, app_evt);
140 vcl_send_session_shutdown (vcl_worker_t *wrk, vcl_session_t *s)
142 app_session_evt_t _app_evt, *app_evt = &_app_evt;
143 session_shutdown_msg_t *mp;
146 /* Send to thread that owns the session */
148 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_SHUTDOWN);
149 mp = (session_shutdown_msg_t *) app_evt->evt->data;
150 memset (mp, 0, sizeof (*mp));
151 mp->client_index = wrk->api_client_handle;
152 mp->handle = s->vpp_handle;
153 app_send_ctrl_evt_to_vpp (mq, app_evt);
157 vcl_send_session_disconnect (vcl_worker_t * wrk, vcl_session_t * s)
159 app_session_evt_t _app_evt, *app_evt = &_app_evt;
160 session_disconnect_msg_t *mp;
163 /* Send to thread that owns the session */
165 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_DISCONNECT);
166 mp = (session_disconnect_msg_t *) app_evt->evt->data;
167 memset (mp, 0, sizeof (*mp));
168 mp->client_index = wrk->api_client_handle;
169 mp->handle = s->vpp_handle;
170 app_send_ctrl_evt_to_vpp (mq, app_evt);
174 vcl_send_app_detach (vcl_worker_t * wrk)
176 app_session_evt_t _app_evt, *app_evt = &_app_evt;
177 session_app_detach_msg_t *mp;
180 mq = vcl_worker_ctrl_mq (wrk);
181 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_DETACH);
182 mp = (session_app_detach_msg_t *) app_evt->evt->data;
183 memset (mp, 0, sizeof (*mp));
184 mp->client_index = wrk->api_client_handle;
185 app_send_ctrl_evt_to_vpp (mq, app_evt);
189 vcl_send_session_accepted_reply (svm_msg_q_t * mq, u32 context,
190 session_handle_t handle, int retval)
192 app_session_evt_t _app_evt, *app_evt = &_app_evt;
193 session_accepted_reply_msg_t *rmp;
194 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_ACCEPTED_REPLY);
195 rmp = (session_accepted_reply_msg_t *) app_evt->evt->data;
196 rmp->handle = handle;
197 rmp->context = context;
198 rmp->retval = retval;
199 app_send_ctrl_evt_to_vpp (mq, app_evt);
203 vcl_send_session_disconnected_reply (vcl_worker_t * wrk, vcl_session_t * s,
206 app_session_evt_t _app_evt, *app_evt = &_app_evt;
207 session_disconnected_reply_msg_t *rmp;
208 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
209 SESSION_CTRL_EVT_DISCONNECTED_REPLY);
210 rmp = (session_disconnected_reply_msg_t *) app_evt->evt->data;
211 rmp->handle = s->vpp_handle;
212 rmp->context = wrk->api_client_handle;
213 rmp->retval = retval;
214 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
218 vcl_send_session_reset_reply (vcl_worker_t * wrk, vcl_session_t * s,
221 app_session_evt_t _app_evt, *app_evt = &_app_evt;
222 session_reset_reply_msg_t *rmp;
223 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
224 SESSION_CTRL_EVT_RESET_REPLY);
225 rmp = (session_reset_reply_msg_t *) app_evt->evt->data;
226 rmp->handle = s->vpp_handle;
227 rmp->context = wrk->api_client_handle;
228 rmp->retval = retval;
229 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
233 vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
236 app_session_evt_t _app_evt, *app_evt = &_app_evt;
237 session_worker_update_msg_t *mp;
239 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
240 SESSION_CTRL_EVT_WORKER_UPDATE);
241 mp = (session_worker_update_msg_t *) app_evt->evt->data;
242 mp->client_index = wrk->api_client_handle;
243 mp->handle = s->vpp_handle;
244 mp->req_wrk_index = wrk->vpp_wrk_index;
245 mp->wrk_index = wrk_index;
246 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
250 vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len)
252 app_session_evt_t _app_evt, *app_evt = &_app_evt;
253 session_app_wrk_rpc_msg_t *mp;
254 vcl_worker_t *dst_wrk, *wrk;
258 if (data_len > sizeof (mp->data))
261 clib_spinlock_lock (&vcm->workers_lock);
263 dst_wrk = vcl_worker_get_if_valid (dst_wrk_index);
267 wrk = vcl_worker_get_current ();
268 mq = vcl_worker_ctrl_mq (wrk);
269 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_WRK_RPC);
270 mp = (session_app_wrk_rpc_msg_t *) app_evt->evt->data;
271 mp->client_index = wrk->api_client_handle;
272 mp->wrk_index = dst_wrk->vpp_wrk_index;
273 clib_memcpy (mp->data, data, data_len);
274 app_send_ctrl_evt_to_vpp (mq, app_evt);
278 clib_spinlock_unlock (&vcm->workers_lock);
283 vcl_session_transport_attr (vcl_worker_t *wrk, vcl_session_t *s, u8 is_get,
284 transport_endpt_attr_t *attr)
286 app_session_evt_t _app_evt, *app_evt = &_app_evt;
287 session_transport_attr_msg_t *mp;
291 ASSERT (!wrk->session_attr_op);
293 if (PREDICT_FALSE (!mq))
295 /* FIXME: attribute should be stored and sent once session is
296 * bound/connected to vpp */
300 wrk->session_attr_op = 1;
301 wrk->session_attr_op_rv = -1;
303 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_TRANSPORT_ATTR);
304 mp = (session_transport_attr_msg_t *) app_evt->evt->data;
305 memset (mp, 0, sizeof (*mp));
306 mp->client_index = wrk->api_client_handle;
307 mp->handle = s->vpp_handle;
310 app_send_ctrl_evt_to_vpp (mq, app_evt);
312 timeout = clib_time_now (&wrk->clib_time) + 1;
314 while (wrk->session_attr_op && clib_time_now (&wrk->clib_time) < timeout)
315 vcl_flush_mq_events ();
317 if (!wrk->session_attr_op_rv && is_get)
318 *attr = wrk->session_attr_rv;
320 wrk->session_attr_op = 0;
322 return wrk->session_attr_op_rv;
326 vcl_session_accepted_handler (vcl_worker_t * wrk, session_accepted_msg_t * mp,
329 vcl_session_t *session, *listen_session;
332 session = vcl_session_alloc (wrk);
334 listen_session = vcl_session_get (wrk, ls_index);
335 if (listen_session->vpp_handle != mp->listener_handle)
337 VDBG (0, "ERROR: listener handle %lu does not match session %u",
338 mp->listener_handle, ls_index);
342 if (vcl_segment_attach_session (
343 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
344 mp->vpp_event_queue_address, mp->mq_index, 0, session))
346 VDBG (0, "session %u [0x%llx]: failed to attach fifos",
347 session->session_index, mp->handle);
351 session->vpp_handle = mp->handle;
352 session->session_state = VCL_STATE_READY;
353 session->transport.rmt_port = mp->rmt.port;
354 session->transport.is_ip4 = mp->rmt.is_ip4;
355 clib_memcpy_fast (&session->transport.rmt_ip, &mp->rmt.ip,
356 sizeof (ip46_address_t));
358 vcl_session_table_add_vpp_handle (wrk, mp->handle, session->session_index);
359 session->transport.lcl_port = mp->lcl.port;
360 session->transport.lcl_ip = mp->lcl.ip;
361 session->session_type = listen_session->session_type;
362 session->is_dgram = vcl_proto_is_dgram (session->session_type);
363 session->listener_index = listen_session->session_index;
364 listen_session->n_accepted_sessions++;
366 vcl_evt (VCL_EVT_ACCEPT, session, listen_session, session_index);
368 vcl_send_session_accepted_reply (session->vpp_evt_q, mp->context,
369 session->vpp_handle, 0);
371 return session->session_index;
374 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0),
375 mp->vpp_event_queue_address, mp->mq_index, &evt_q);
376 vcl_send_session_accepted_reply (evt_q, mp->context, mp->handle,
377 VNET_API_ERROR_INVALID_ARGUMENT);
378 vcl_session_free (wrk, session);
379 return VCL_INVALID_SESSION_INDEX;
383 vcl_session_connected_handler (vcl_worker_t * wrk,
384 session_connected_msg_t * mp)
386 vcl_session_t *session = 0;
389 session_index = mp->context;
390 session = vcl_session_get (wrk, session_index);
391 if (PREDICT_FALSE (!session))
393 VERR ("vpp handle 0x%llx has no session index (%u)!", mp->handle,
395 /* Should not happen but if it does, force vpp session cleanup */
396 vcl_session_t tmp_session = {
397 .vpp_handle = mp->handle,
400 vcl_segment_attach_session (
401 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
402 mp->vpp_event_queue_address, mp->mq_index, 0, session);
403 if (tmp_session.vpp_evt_q)
404 vcl_send_session_disconnect (wrk, &tmp_session);
405 return VCL_INVALID_SESSION_INDEX;
410 VDBG (0, "session %u: connect failed! %U", session_index,
411 format_session_error, mp->retval);
412 session->session_state = VCL_STATE_DETACHED;
413 session->vpp_handle = VCL_INVALID_SESSION_HANDLE;
414 session->vpp_error = mp->retval;
415 return session_index;
418 session->vpp_handle = mp->handle;
420 /* Add to lookup table. Even if something fails, session cannot be
421 * cleaned up prior to notifying vpp and going through the cleanup
422 * "procedure" see @ref vcl_session_cleanup_handler */
423 vcl_session_table_add_vpp_handle (wrk, mp->handle, session_index);
425 if (vcl_segment_attach_session (
426 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
427 mp->vpp_event_queue_address, mp->mq_index, 0, session))
429 VDBG (0, "session %u [0x%llx]: failed to attach fifos",
430 session->session_index, session->vpp_handle);
431 session->session_state = VCL_STATE_UPDATED;
432 vcl_send_session_disconnect (wrk, session);
433 return session_index;
438 if (vcl_segment_attach_session (mp->ct_segment_handle, mp->ct_rx_fifo,
439 mp->ct_tx_fifo, (uword) ~0, ~0, 1,
442 VDBG (0, "session %u [0x%llx]: failed to attach ct fifos",
443 session->session_index, session->vpp_handle);
444 session->session_state = VCL_STATE_UPDATED;
445 vcl_send_session_disconnect (wrk, session);
446 return session_index;
450 session->transport.is_ip4 = mp->lcl.is_ip4;
451 clib_memcpy_fast (&session->transport.lcl_ip, &mp->lcl.ip,
452 sizeof (session->transport.lcl_ip));
453 session->transport.lcl_port = mp->lcl.port;
455 /* Application closed session before connect reply */
456 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK)
457 && session->session_state == VCL_STATE_CLOSED)
458 vcl_send_session_disconnect (wrk, session);
460 session->session_state = VCL_STATE_READY;
462 VDBG (0, "session %u [0x%llx] connected local: %U:%u remote %U:%u",
463 session->session_index, session->vpp_handle, vcl_format_ip46_address,
464 &session->transport.lcl_ip,
465 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
466 clib_net_to_host_u16 (session->transport.lcl_port),
467 vcl_format_ip46_address, &session->transport.rmt_ip,
468 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
469 clib_net_to_host_u16 (session->transport.rmt_port));
471 return session_index;
475 vcl_flag_accepted_session (vcl_session_t * session, u64 handle, u32 flags)
477 vcl_session_msg_t *accepted_msg;
480 for (i = 0; i < vec_len (session->accept_evts_fifo); i++)
482 accepted_msg = &session->accept_evts_fifo[i];
483 if (accepted_msg->accepted_msg.handle == handle)
485 accepted_msg->flags |= flags;
493 vcl_session_reset_handler (vcl_worker_t * wrk,
494 session_reset_msg_t * reset_msg)
496 vcl_session_t *session;
499 sid = vcl_session_index_from_vpp_handle (wrk, reset_msg->handle);
500 session = vcl_session_get (wrk, sid);
503 VDBG (0, "request to reset unknown handle 0x%llx", reset_msg->handle);
504 return VCL_INVALID_SESSION_INDEX;
507 /* Caught a reset before actually accepting the session */
508 if (session->session_state == VCL_STATE_LISTEN)
511 if (!vcl_flag_accepted_session (session, reset_msg->handle,
512 VCL_ACCEPTED_F_RESET))
513 VDBG (0, "session was not accepted!");
514 return VCL_INVALID_SESSION_INDEX;
517 if (session->session_state != VCL_STATE_CLOSED)
518 session->session_state = VCL_STATE_DISCONNECT;
519 VDBG (0, "session %u [0x%llx]: reset", sid, reset_msg->handle);
524 vcl_session_bound_handler (vcl_worker_t * wrk, session_bound_msg_t * mp)
526 vcl_session_t *session;
527 u32 sid = mp->context;
529 session = vcl_session_get (wrk, sid);
532 VERR ("session %u [0x%llx]: bind failed: %U", sid, mp->handle,
533 format_session_error, mp->retval);
536 session->session_state = VCL_STATE_DETACHED;
537 session->vpp_handle = mp->handle;
542 VDBG (0, "session %u [0x%llx]: Invalid session index!", sid,
544 return VCL_INVALID_SESSION_INDEX;
548 session->vpp_handle = mp->handle;
549 session->transport.is_ip4 = mp->lcl_is_ip4;
550 clib_memcpy_fast (&session->transport.lcl_ip, mp->lcl_ip,
551 sizeof (ip46_address_t));
552 session->transport.lcl_port = mp->lcl_port;
553 vcl_session_table_add_listener (wrk, mp->handle, sid);
554 session->session_state = VCL_STATE_LISTEN;
556 if (vcl_session_is_cl (session))
558 if (vcl_segment_attach_session (mp->segment_handle, mp->rx_fifo,
559 mp->tx_fifo, mp->vpp_evt_q, mp->mq_index,
562 VDBG (0, "session %u [0x%llx]: failed to attach fifos",
563 session->session_index, session->vpp_handle);
564 session->session_state = VCL_STATE_DETACHED;
565 return VCL_INVALID_SESSION_INDEX;
569 VDBG (0, "session %u [0x%llx]: listen succeeded!", sid, mp->handle);
574 vcl_session_unlisten_reply_handler (vcl_worker_t * wrk, void *data)
576 session_unlisten_reply_msg_t *mp = (session_unlisten_reply_msg_t *) data;
579 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
582 VDBG (0, "Unlisten reply with wrong handle %llx", mp->handle);
585 if (s->session_state != VCL_STATE_DISCONNECT)
587 /* Connected udp listener */
588 if (s->session_type == VPPCOM_PROTO_UDP
589 && s->session_state == VCL_STATE_CLOSED)
592 VDBG (0, "Unlisten session in wrong state %llx", mp->handle);
597 VDBG (0, "ERROR: session %u [0xllx]: unlisten failed: %U",
598 s->session_index, mp->handle, format_session_error, mp->retval);
600 if (mp->context != wrk->wrk_index)
601 VDBG (0, "wrong context");
603 vcl_session_table_del_vpp_handle (wrk, mp->handle);
604 vcl_session_free (wrk, s);
608 vcl_session_migrated_handler (vcl_worker_t * wrk, void *data)
610 session_migrated_msg_t *mp = (session_migrated_msg_t *) data;
614 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
617 VDBG (0, "Migrated notification with wrong handle %llx", mp->handle);
621 /* Only validate if a value is provided */
622 if (mp->segment_handle != SESSION_INVALID_HANDLE)
624 fs_index = vcl_segment_table_lookup (mp->segment_handle);
625 if (fs_index == VCL_INVALID_SEGMENT_INDEX)
627 VDBG (0, "segment %lx for session %u is not mounted!",
628 mp->segment_handle, s->session_index);
629 s->session_state = VCL_STATE_DETACHED;
634 s->vpp_handle = mp->new_handle;
636 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0), mp->vpp_evt_q,
637 mp->vpp_thread_index, &s->vpp_evt_q);
639 vcl_session_table_del_vpp_handle (wrk, mp->handle);
640 vcl_session_table_add_vpp_handle (wrk, mp->new_handle, s->session_index);
642 /* Generate new tx event if we have outstanding data */
643 if (svm_fifo_has_event (s->tx_fifo))
644 app_send_io_evt_to_vpp (s->vpp_evt_q,
645 s->tx_fifo->shr->master_session_index,
646 SESSION_IO_EVT_TX, SVM_Q_WAIT);
648 VDBG (0, "Migrated 0x%lx to thread %u 0x%lx", mp->handle,
649 mp->vpp_thread_index, mp->new_handle);
652 static vcl_session_t *
653 vcl_session_accepted (vcl_worker_t * wrk, session_accepted_msg_t * msg)
655 vcl_session_msg_t *vcl_msg;
656 vcl_session_t *session;
658 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
659 if (PREDICT_FALSE (session != 0))
660 VWRN ("session overlap handle %lu state %u!", msg->handle,
661 session->session_state);
663 session = vcl_session_table_lookup_listener (wrk, msg->listener_handle);
666 VERR ("couldn't find listen session: listener handle %llx",
667 msg->listener_handle);
671 clib_fifo_add2 (session->accept_evts_fifo, vcl_msg);
673 vcl_msg->accepted_msg = *msg;
674 /* Session handle points to listener until fully accepted by app */
675 vcl_session_table_add_vpp_handle (wrk, msg->handle, session->session_index);
680 static vcl_session_t *
681 vcl_session_disconnected_handler (vcl_worker_t * wrk,
682 session_disconnected_msg_t * msg)
684 vcl_session_t *session;
686 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
689 VWRN ("request to disconnect unknown handle 0x%llx", msg->handle);
693 /* Late disconnect notification on a session that has been closed */
694 if (session->session_state == VCL_STATE_CLOSED)
697 /* Caught a disconnect before actually accepting the session */
698 if (session->session_state == VCL_STATE_LISTEN)
700 if (!vcl_flag_accepted_session (session, msg->handle,
701 VCL_ACCEPTED_F_CLOSED))
702 VDBG (0, "session was not accepted!");
706 /* If not already reset change state */
707 if (session->session_state != VCL_STATE_DISCONNECT)
708 session->session_state = VCL_STATE_VPP_CLOSING;
714 vppcom_session_shutdown (uint32_t session_handle, int how)
716 vcl_worker_t *wrk = vcl_worker_get_current ();
717 vcl_session_t *session;
718 vcl_session_state_t state;
721 session = vcl_session_get_w_handle (wrk, session_handle);
722 if (PREDICT_FALSE (!session))
723 return VPPCOM_EBADFD;
725 vpp_handle = session->vpp_handle;
726 state = session->session_state;
728 VDBG (1, "session %u [0x%llx] state 0x%x (%s)", session->session_index,
729 vpp_handle, state, vcl_session_state_str (state));
731 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
733 VDBG (0, "ERROR: Cannot shutdown a listen socket!");
734 return VPPCOM_EBADFD;
737 if (how == SHUT_RD || how == SHUT_RDWR)
739 session->flags |= VCL_SESSION_F_RD_SHUTDOWN;
743 session->flags |= VCL_SESSION_F_WR_SHUTDOWN;
745 if (PREDICT_TRUE (state == VCL_STATE_READY))
747 VDBG (1, "session %u [0x%llx]: sending shutdown...",
748 session->session_index, vpp_handle);
750 vcl_send_session_shutdown (wrk, session);
757 vppcom_session_disconnect (u32 session_handle)
759 vcl_worker_t *wrk = vcl_worker_get_current ();
760 vcl_session_t *session, *listen_session;
761 vcl_session_state_t state;
764 session = vcl_session_get_w_handle (wrk, session_handle);
766 return VPPCOM_EBADFD;
768 vpp_handle = session->vpp_handle;
769 state = session->session_state;
771 VDBG (1, "session %u [0x%llx]: disconnecting state (%s)",
772 session->session_index, vpp_handle, vcl_session_state_str (state));
774 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
776 VDBG (0, "ERROR: Cannot disconnect a listen socket!");
777 return VPPCOM_EBADFD;
780 if (state == VCL_STATE_VPP_CLOSING)
782 vcl_send_session_disconnected_reply (wrk, session, 0);
783 VDBG (1, "session %u [0x%llx]: sending disconnect REPLY...",
784 session->session_index, vpp_handle);
788 /* Session doesn't have an event queue yet. Probably a non-blocking
789 * connect. Wait for the reply */
790 if (PREDICT_FALSE (!session->vpp_evt_q))
793 VDBG (1, "session %u [0x%llx]: sending disconnect",
794 session->session_index, vpp_handle);
795 vcl_send_session_disconnect (wrk, session);
798 if (session->listener_index != VCL_INVALID_SESSION_INDEX)
800 listen_session = vcl_session_get (wrk, session->listener_index);
802 listen_session->n_accepted_sessions--;
809 vcl_session_cleanup_handler (vcl_worker_t * wrk, void *data)
811 session_cleanup_msg_t *msg;
812 vcl_session_t *session;
814 msg = (session_cleanup_msg_t *) data;
815 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
818 VWRN ("disconnect confirmed for unknown handle 0x%llx", msg->handle);
822 if (msg->type == SESSION_CLEANUP_TRANSPORT)
824 /* Transport was cleaned up before we confirmed close. Probably the
825 * app is still waiting for some data that cannot be delivered.
826 * Confirm close to make sure everything is cleaned up.
827 * Move to undetermined state to ensure that the session is not
828 * removed before both vpp and the app cleanup.
829 * - If the app closes first, the session is moved to CLOSED state
830 * and the session cleanup notification from vpp removes the
832 * - If vpp cleans up the session first, the session is moved to
833 * DETACHED state lower and subsequently the close from the app
836 if (session->session_state == VCL_STATE_VPP_CLOSING)
838 vppcom_session_disconnect (vcl_session_handle (session));
839 session->session_state = VCL_STATE_UPDATED;
841 else if (session->session_state == VCL_STATE_DISCONNECT)
843 vcl_send_session_reset_reply (wrk, session, 0);
844 session->session_state = VCL_STATE_UPDATED;
849 /* VPP will reuse the handle so clean it up now */
850 vcl_session_table_del_vpp_handle (wrk, msg->handle);
852 /* App did not close the connection yet so don't free it. */
853 if (session->session_state != VCL_STATE_CLOSED)
855 VDBG (0, "session %u: app did not close", session->session_index);
856 session->session_state = VCL_STATE_DETACHED;
857 session->vpp_handle = VCL_INVALID_SESSION_HANDLE;
861 /* Session probably tracked with epoll, disconnect not yet handled and
862 * 1) both transport and session cleanup completed 2) app closed. Wait
863 * until message is drained to free the session.
864 * See @ref vcl_handle_mq_event */
865 if (session->flags & VCL_SESSION_F_PENDING_DISCONNECT)
867 session->flags |= VCL_SESSION_F_PENDING_FREE;
871 vcl_session_free (wrk, session);
875 vcl_session_req_worker_update_handler (vcl_worker_t * wrk, void *data)
877 session_req_worker_update_msg_t *msg;
880 msg = (session_req_worker_update_msg_t *) data;
881 s = vcl_session_get_w_vpp_handle (wrk, msg->session_handle);
885 vec_add1 (wrk->pending_session_wrk_updates, s->session_index);
889 vcl_session_worker_update_reply_handler (vcl_worker_t * wrk, void *data)
891 session_worker_update_reply_msg_t *msg;
894 msg = (session_worker_update_reply_msg_t *) data;
895 s = vcl_session_get_w_vpp_handle (wrk, msg->handle);
898 VDBG (0, "unknown handle 0x%llx", msg->handle);
904 if (vcl_segment_attach_session (msg->segment_handle, msg->rx_fifo,
905 msg->tx_fifo, (uword) ~0, ~0, 0, s))
907 VDBG (0, "failed to attach fifos for %u", s->session_index);
911 s->session_state = VCL_STATE_UPDATED;
913 VDBG (0, "session %u[0x%llx] moved to worker %u", s->session_index,
914 s->vpp_handle, wrk->wrk_index);
918 vcl_api_recv_fd (vcl_worker_t * wrk, int *fds, int n_fds)
921 if (vcm->cfg.vpp_app_socket_api)
922 return vcl_sapi_recv_fds (wrk, fds, n_fds);
924 return vcl_bapi_recv_fds (wrk, fds, n_fds);
928 vcl_session_app_add_segment_handler (vcl_worker_t * wrk, void *data)
930 ssvm_segment_type_t seg_type = SSVM_SEGMENT_SHM;
931 session_app_add_segment_msg_t *msg;
935 msg = (session_app_add_segment_msg_t *) data;
939 vcl_api_recv_fd (wrk, &fd, 1);
940 seg_type = SSVM_SEGMENT_MEMFD;
943 segment_handle = msg->segment_handle;
944 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
946 clib_warning ("invalid segment handle");
950 if (vcl_segment_attach (segment_handle, (char *) msg->segment_name,
953 VDBG (0, "vcl_segment_attach ('%s') failed", msg->segment_name);
957 VDBG (1, "mapped new segment '%s' size %d", msg->segment_name,
962 vcl_session_app_del_segment_handler (vcl_worker_t * wrk, void *data)
964 session_app_del_segment_msg_t *msg = (session_app_del_segment_msg_t *) data;
965 vcl_segment_detach (msg->segment_handle);
966 VDBG (1, "Unmapped segment: %d", msg->segment_handle);
970 vcl_worker_rpc_handler (vcl_worker_t * wrk, void *data)
972 if (!vcm->wrk_rpc_fn)
975 (vcm->wrk_rpc_fn) (((session_app_wrk_rpc_msg_t *) data)->data);
979 vcl_session_transport_attr_reply_handler (vcl_worker_t *wrk, void *data)
981 session_transport_attr_reply_msg_t *mp;
983 if (!wrk->session_attr_op)
986 mp = (session_transport_attr_reply_msg_t *) data;
988 wrk->session_attr_op_rv = mp->retval;
989 wrk->session_attr_op = 0;
990 wrk->session_attr_rv = mp->attr;
994 vcl_handle_mq_event (vcl_worker_t * wrk, session_event_t * e)
996 session_disconnected_msg_t *disconnected_msg;
997 session_connected_msg_t *connected_msg;
998 session_reset_msg_t *reset_msg;
999 session_event_t *ecpy;
1003 switch (e->event_type)
1005 case SESSION_IO_EVT_RX:
1006 case SESSION_IO_EVT_TX:
1007 s = vcl_session_get (wrk, e->session_index);
1008 if (!s || !vcl_session_is_open (s))
1010 vec_add1 (wrk->unhandled_evts_vector, *e);
1012 case SESSION_CTRL_EVT_BOUND:
1013 /* We can only wait for only one listen so not postponed */
1014 vcl_session_bound_handler (wrk, (session_bound_msg_t *) e->data);
1016 case SESSION_CTRL_EVT_ACCEPTED:
1017 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
1018 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1020 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1022 ecpy->postponed = 1;
1023 ecpy->session_index = s->session_index;
1026 case SESSION_CTRL_EVT_CONNECTED:
1027 connected_msg = (session_connected_msg_t *) e->data;
1028 sid = vcl_session_connected_handler (wrk, connected_msg);
1029 if (!(s = vcl_session_get (wrk, sid)))
1031 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1033 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1035 ecpy->postponed = 1;
1036 ecpy->session_index = s->session_index;
1039 case SESSION_CTRL_EVT_DISCONNECTED:
1040 disconnected_msg = (session_disconnected_msg_t *) e->data;
1041 if (!(s = vcl_session_get_w_vpp_handle (wrk, disconnected_msg->handle)))
1043 if (s->session_state == VCL_STATE_CLOSED)
1045 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1047 s->session_state = VCL_STATE_VPP_CLOSING;
1048 s->flags |= VCL_SESSION_F_PENDING_DISCONNECT;
1049 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1051 ecpy->postponed = 1;
1052 ecpy->session_index = s->session_index;
1055 if (!(s = vcl_session_disconnected_handler (wrk, disconnected_msg)))
1057 VDBG (0, "disconnected session %u [0x%llx]", s->session_index,
1060 case SESSION_CTRL_EVT_RESET:
1061 reset_msg = (session_reset_msg_t *) e->data;
1062 if (!(s = vcl_session_get_w_vpp_handle (wrk, reset_msg->handle)))
1064 if (s->session_state == VCL_STATE_CLOSED)
1066 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1068 s->flags |= VCL_SESSION_F_PENDING_DISCONNECT;
1069 s->session_state = VCL_STATE_DISCONNECT;
1070 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1072 ecpy->postponed = 1;
1073 ecpy->session_index = s->session_index;
1076 vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
1078 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
1079 vcl_session_unlisten_reply_handler (wrk, e->data);
1081 case SESSION_CTRL_EVT_MIGRATED:
1082 vcl_session_migrated_handler (wrk, e->data);
1084 case SESSION_CTRL_EVT_CLEANUP:
1085 vcl_session_cleanup_handler (wrk, e->data);
1087 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
1088 vcl_session_req_worker_update_handler (wrk, e->data);
1090 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
1091 vcl_session_worker_update_reply_handler (wrk, e->data);
1093 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
1094 vcl_session_app_add_segment_handler (wrk, e->data);
1096 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
1097 vcl_session_app_del_segment_handler (wrk, e->data);
1099 case SESSION_CTRL_EVT_APP_WRK_RPC:
1100 vcl_worker_rpc_handler (wrk, e->data);
1102 case SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY:
1103 vcl_session_transport_attr_reply_handler (wrk, e->data);
1106 clib_warning ("unhandled %u", e->event_type);
1112 vppcom_wait_for_session_state_change (u32 session_index,
1113 vcl_session_state_t state,
1116 vcl_worker_t *wrk = vcl_worker_get_current ();
1117 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
1118 vcl_session_t *volatile session;
1119 svm_msg_q_msg_t msg;
1124 session = vcl_session_get (wrk, session_index);
1125 if (PREDICT_FALSE (!session))
1127 return VPPCOM_EBADFD;
1129 if (session->session_state == state)
1133 if (session->session_state == VCL_STATE_DETACHED)
1135 return VPPCOM_ECONNREFUSED;
1138 if (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0))
1143 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
1144 vcl_handle_mq_event (wrk, e);
1145 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
1147 while (clib_time_now (&wrk->clib_time) < timeout);
1149 VDBG (0, "timeout waiting for state 0x%x (%s)", state,
1150 vcl_session_state_str (state));
1151 vcl_evt (VCL_EVT_SESSION_TIMEOUT, session, session_state);
1153 return VPPCOM_ETIMEDOUT;
1157 vcl_handle_pending_wrk_updates (vcl_worker_t * wrk)
1159 vcl_session_state_t state;
1163 if (PREDICT_TRUE (vec_len (wrk->pending_session_wrk_updates) == 0))
1166 vec_foreach (sip, wrk->pending_session_wrk_updates)
1168 s = vcl_session_get (wrk, *sip);
1169 vcl_send_session_worker_update (wrk, s, wrk->wrk_index);
1170 state = s->session_state;
1171 vppcom_wait_for_session_state_change (s->session_index, VCL_STATE_UPDATED,
1173 s->session_state = state;
1175 vec_reset_length (wrk->pending_session_wrk_updates);
1179 vcl_worker_flush_mq_events (vcl_worker_t *wrk)
1181 svm_msg_q_msg_t *msg;
1186 mq = wrk->app_event_queue;
1187 vcl_mq_dequeue_batch (wrk, mq, ~0);
1189 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
1191 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
1192 e = svm_msg_q_msg_data (mq, msg);
1193 vcl_handle_mq_event (wrk, e);
1194 svm_msg_q_free_msg (mq, msg);
1196 vec_reset_length (wrk->mq_msg_vector);
1197 vcl_handle_pending_wrk_updates (wrk);
1201 vcl_flush_mq_events (void)
1203 vcl_worker_flush_mq_events (vcl_worker_get_current ());
1207 vppcom_session_unbind (u32 session_handle)
1209 vcl_worker_t *wrk = vcl_worker_get_current ();
1210 session_accepted_msg_t *accepted_msg;
1211 vcl_session_t *session = 0;
1212 vcl_session_msg_t *evt;
1214 session = vcl_session_get_w_handle (wrk, session_handle);
1216 return VPPCOM_EBADFD;
1218 /* Flush pending accept events, if any */
1219 while (clib_fifo_elts (session->accept_evts_fifo))
1221 clib_fifo_sub2 (session->accept_evts_fifo, evt);
1222 accepted_msg = &evt->accepted_msg;
1223 vcl_session_table_del_vpp_handle (wrk, accepted_msg->handle);
1224 vcl_send_session_accepted_reply (session->vpp_evt_q,
1225 accepted_msg->context,
1226 accepted_msg->handle, -1);
1228 clib_fifo_free (session->accept_evts_fifo);
1230 vcl_send_session_unlisten (wrk, session);
1232 VDBG (1, "session %u [0x%llx]: sending unbind!", session->session_index,
1233 session->vpp_handle);
1234 vcl_evt (VCL_EVT_UNBIND, session);
1236 session->vpp_handle = ~0;
1237 session->session_state = VCL_STATE_DISCONNECT;
1245 * Notify vpp of the disconnect and mark the worker as free. If we're the
1246 * last worker, do a full cleanup otherwise, since we're probably a forked
1247 * child, avoid syscalls as much as possible. We might've lost privileges.
1250 vppcom_app_exit (void)
1252 if (!pool_elts (vcm->workers))
1254 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
1255 vcl_set_worker_index (~0);
1256 vcl_elog_stop (vcm);
1260 vcl_api_attach (void)
1262 if (vcm->cfg.vpp_app_socket_api)
1263 return vcl_sapi_attach ();
1265 return vcl_bapi_attach ();
1269 vcl_api_retry_attach (vcl_worker_t *wrk)
1273 if (vcl_api_attach ())
1276 /* Treat listeners as configuration that needs to be re-added to vpp */
1277 pool_foreach (s, wrk->sessions)
1279 if (s->flags & VCL_SESSION_F_IS_VEP)
1281 if (s->session_state == VCL_STATE_LISTEN_NO_MQ)
1282 vppcom_session_listen (vcl_session_handle (s), 10);
1284 VDBG (0, "internal error: unexpected state %d", s->session_state);
1289 vcl_api_handle_disconnect (vcl_worker_t *wrk)
1291 wrk->api_client_handle = ~0;
1292 vcl_worker_detach_sessions (wrk);
1296 vcl_api_detach (vcl_worker_t * wrk)
1298 if (wrk->api_client_handle == ~0)
1301 vcl_send_app_detach (wrk);
1303 if (vcm->cfg.vpp_app_socket_api)
1304 return vcl_sapi_detach (wrk);
1306 return vcl_bapi_disconnect_from_vpp ();
1310 * VPPCOM Public API functions
1313 vppcom_app_create (const char *app_name)
1315 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1320 VDBG (1, "already initialized");
1321 return VPPCOM_EEXIST;
1325 vppcom_cfg (&vcm->cfg);
1326 vcl_cfg = &vcm->cfg;
1328 vcm->main_cpu = pthread_self ();
1329 vcm->main_pid = getpid ();
1330 vcm->app_name = format (0, "%s", app_name);
1331 fifo_segment_main_init (&vcm->segment_main, (uword) ~0,
1332 20 /* timeout in secs */);
1333 pool_alloc (vcm->workers, vcl_cfg->max_workers);
1334 clib_spinlock_init (&vcm->workers_lock);
1335 clib_rwlock_init (&vcm->segment_table_lock);
1336 atexit (vppcom_app_exit);
1337 vcl_elog_init (vcm);
1339 /* Allocate default worker */
1340 vcl_worker_alloc_and_init ();
1342 if ((rv = vcl_api_attach ()))
1344 vppcom_app_destroy ();
1348 VDBG (0, "app_name '%s', my_client_index %d (0x%x)", app_name,
1349 vcm->workers[0].api_client_handle, vcm->workers[0].api_client_handle);
1355 vppcom_app_destroy (void)
1357 vcl_worker_t *wrk, *current_wrk;
1360 if (!pool_elts (vcm->workers))
1363 vcl_evt (VCL_EVT_DETACH, vcm);
1365 current_wrk = vcl_worker_get_current ();
1368 pool_foreach (wrk, vcm->workers) {
1369 if (current_wrk != wrk)
1370 vcl_worker_cleanup (wrk, 0 /* notify vpp */ );
1374 vcl_api_detach (current_wrk);
1375 vcl_worker_cleanup (current_wrk, 0 /* notify vpp */ );
1376 vcl_set_worker_index (~0);
1378 vcl_elog_stop (vcm);
1381 * Free the heap and fix vcm
1383 heap = clib_mem_get_heap ();
1384 munmap (clib_mem_get_heap_base (heap), clib_mem_get_heap_size (heap));
1386 vcm = &_vppcom_main;
1391 vppcom_session_create (u8 proto, u8 is_nonblocking)
1393 vcl_worker_t *wrk = vcl_worker_get_current ();
1394 vcl_session_t *session;
1396 session = vcl_session_alloc (wrk);
1398 session->session_type = proto;
1399 session->session_state = VCL_STATE_CLOSED;
1400 session->vpp_handle = ~0;
1401 session->is_dgram = vcl_proto_is_dgram (proto);
1402 session->vpp_error = SESSION_E_NONE;
1405 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
1407 vcl_evt (VCL_EVT_CREATE, session, session_type, session->session_state,
1408 is_nonblocking, session_index);
1410 VDBG (0, "created session %u", session->session_index);
1412 return vcl_session_handle (session);
1416 vcl_epoll_lt_add (vcl_worker_t *wrk, vcl_session_t *s)
1418 vcl_session_t *cur, *prev;
1420 if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX)
1422 wrk->ep_lt_current = s->session_index;
1423 s->vep.lt_next = s->session_index;
1424 s->vep.lt_prev = s->session_index;
1428 cur = vcl_session_get (wrk, wrk->ep_lt_current);
1429 prev = vcl_session_get (wrk, cur->vep.lt_prev);
1431 prev->vep.lt_next = s->session_index;
1432 s->vep.lt_prev = prev->session_index;
1434 s->vep.lt_next = cur->session_index;
1435 cur->vep.lt_prev = s->session_index;
1439 vcl_epoll_lt_del (vcl_worker_t *wrk, vcl_session_t *s)
1441 vcl_session_t *prev, *next;
1443 if (s->vep.lt_next == s->session_index)
1445 wrk->ep_lt_current = VCL_INVALID_SESSION_INDEX;
1446 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
1450 prev = vcl_session_get (wrk, s->vep.lt_prev);
1451 next = vcl_session_get (wrk, s->vep.lt_next);
1453 prev->vep.lt_next = next->session_index;
1454 next->vep.lt_prev = prev->session_index;
1456 if (s->session_index == wrk->ep_lt_current)
1457 wrk->ep_lt_current = s->vep.lt_next;
1459 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
1463 vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * s,
1464 vcl_session_handle_t sh, u8 do_disconnect)
1468 VDBG (1, "session %u [0x%llx] closing", s->session_index, s->vpp_handle);
1470 if (s->flags & VCL_SESSION_F_IS_VEP)
1472 u32 next_sh = s->vep.next_sh;
1473 while (next_sh != ~0)
1475 rv = vppcom_epoll_ctl (sh, EPOLL_CTL_DEL, next_sh, 0);
1476 if (PREDICT_FALSE (rv < 0))
1477 VDBG (0, "vpp handle 0x%llx, sh %u: EPOLL_CTL_DEL vep_idx %u"
1478 " failed! rv %d (%s)", s->vpp_handle, next_sh,
1479 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1480 next_sh = s->vep.next_sh;
1485 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
1487 rv = vppcom_epoll_ctl (s->vep.vep_sh, EPOLL_CTL_DEL, sh, 0);
1489 VDBG (0, "session %u [0x%llx]: EPOLL_CTL_DEL vep_idx %u "
1490 "failed! rv %d (%s)", s->session_index, s->vpp_handle,
1491 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1496 VDBG (1, "session %u [0x%llx] disconnect skipped",
1497 s->session_index, s->vpp_handle);
1501 if (s->session_state == VCL_STATE_LISTEN)
1503 rv = vppcom_session_unbind (sh);
1504 if (PREDICT_FALSE (rv < 0))
1505 VDBG (0, "session %u [0x%llx]: listener unbind failed! "
1506 "rv %d (%s)", s->session_index, s->vpp_handle, rv,
1507 vppcom_retval_str (rv));
1510 else if (vcl_session_is_ready (s)
1511 || (vcl_session_is_connectable_listener (wrk, s)))
1513 rv = vppcom_session_disconnect (sh);
1514 if (PREDICT_FALSE (rv < 0))
1515 VDBG (0, "ERROR: session %u [0x%llx]: disconnect failed!"
1516 " rv %d (%s)", s->session_index, s->vpp_handle,
1517 rv, vppcom_retval_str (rv));
1519 else if (s->session_state == VCL_STATE_DISCONNECT)
1521 vcl_send_session_reset_reply (wrk, s, 0);
1523 else if (s->session_state == VCL_STATE_DETACHED)
1525 VDBG (0, "vpp freed session %d before close", s->session_index);
1527 if (!(s->flags & VCL_SESSION_F_PENDING_DISCONNECT))
1530 /* Disconnect/reset messages pending but vpp transport and session
1531 * cleanups already done. Free only after messages drained. */
1532 s->flags |= VCL_SESSION_F_PENDING_FREE;
1535 s->session_state = VCL_STATE_CLOSED;
1537 /* Session is removed only after vpp confirms the disconnect */
1541 vcl_session_table_del_vpp_handle (wrk, s->vpp_handle);
1543 vcl_session_free (wrk, s);
1544 vcl_evt (VCL_EVT_CLOSE, s, rv);
1550 vppcom_session_close (uint32_t session_handle)
1552 vcl_worker_t *wrk = vcl_worker_get_current ();
1553 vcl_session_t *session;
1555 session = vcl_session_get_w_handle (wrk, session_handle);
1557 return VPPCOM_EBADFD;
1558 return vcl_session_cleanup (wrk, session, session_handle,
1559 1 /* do_disconnect */ );
1563 vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep)
1565 vcl_worker_t *wrk = vcl_worker_get_current ();
1566 vcl_session_t *session = 0;
1569 return VPPCOM_EINVAL;
1571 session = vcl_session_get_w_handle (wrk, session_handle);
1573 return VPPCOM_EBADFD;
1575 if (session->flags & VCL_SESSION_F_IS_VEP)
1577 VDBG (0, "ERROR: cannot bind to epoll session %u!",
1578 session->session_index);
1579 return VPPCOM_EBADFD;
1582 session->transport.is_ip4 = ep->is_ip4;
1584 clib_memcpy_fast (&session->transport.lcl_ip.ip4, ep->ip,
1585 sizeof (ip4_address_t));
1587 clib_memcpy_fast (&session->transport.lcl_ip.ip6, ep->ip,
1588 sizeof (ip6_address_t));
1589 session->transport.lcl_port = ep->port;
1592 "session %u handle %u: binding to local %s address %U port %u, "
1594 session->session_index, session_handle,
1595 session->transport.is_ip4 ? "IPv4" : "IPv6", vcl_format_ip46_address,
1596 &session->transport.lcl_ip,
1597 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1598 clib_net_to_host_u16 (session->transport.lcl_port),
1599 vppcom_proto_str (session->session_type));
1600 vcl_evt (VCL_EVT_BIND, session);
1602 if (session->session_type == VPPCOM_PROTO_UDP)
1603 vppcom_session_listen (session_handle, 10);
1609 vppcom_session_listen (uint32_t listen_sh, uint32_t q_len)
1611 vcl_worker_t *wrk = vcl_worker_get_current ();
1612 vcl_session_t *listen_session = 0;
1613 u64 listen_vpp_handle;
1616 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1617 if (!listen_session || (listen_session->flags & VCL_SESSION_F_IS_VEP))
1618 return VPPCOM_EBADFD;
1620 listen_vpp_handle = listen_session->vpp_handle;
1621 if (listen_session->session_state == VCL_STATE_LISTEN)
1623 VDBG (0, "session %u [0x%llx]: already in listen state!",
1624 listen_sh, listen_vpp_handle);
1628 VDBG (0, "session %u: sending vpp listen request...", listen_sh);
1631 * Send listen request to vpp and wait for reply
1633 vcl_send_session_listen (wrk, listen_session);
1634 rv = vppcom_wait_for_session_state_change (listen_session->session_index,
1636 vcm->cfg.session_timeout);
1638 if (PREDICT_FALSE (rv))
1640 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1641 VDBG (0, "session %u [0x%llx]: listen failed! returning %d (%s)",
1642 listen_sh, listen_session->vpp_handle, rv,
1643 vppcom_retval_str (rv));
1651 validate_args_session_accept_ (vcl_worker_t * wrk, vcl_session_t * ls)
1653 if (ls->flags & VCL_SESSION_F_IS_VEP)
1655 VDBG (0, "ERROR: cannot accept on epoll session %u!",
1657 return VPPCOM_EBADFD;
1660 if ((ls->session_state != VCL_STATE_LISTEN)
1661 && (!vcl_session_is_connectable_listener (wrk, ls)))
1664 "ERROR: session [0x%llx]: not in listen state! state 0x%x"
1666 ls->vpp_handle, ls->session_state,
1667 vcl_session_state_str (ls->session_state));
1668 return VPPCOM_EBADFD;
1674 vppcom_unformat_proto (uint8_t * proto, char *proto_str)
1676 if (!strcmp (proto_str, "TCP"))
1677 *proto = VPPCOM_PROTO_TCP;
1678 else if (!strcmp (proto_str, "tcp"))
1679 *proto = VPPCOM_PROTO_TCP;
1680 else if (!strcmp (proto_str, "UDP"))
1681 *proto = VPPCOM_PROTO_UDP;
1682 else if (!strcmp (proto_str, "udp"))
1683 *proto = VPPCOM_PROTO_UDP;
1684 else if (!strcmp (proto_str, "TLS"))
1685 *proto = VPPCOM_PROTO_TLS;
1686 else if (!strcmp (proto_str, "tls"))
1687 *proto = VPPCOM_PROTO_TLS;
1688 else if (!strcmp (proto_str, "QUIC"))
1689 *proto = VPPCOM_PROTO_QUIC;
1690 else if (!strcmp (proto_str, "quic"))
1691 *proto = VPPCOM_PROTO_QUIC;
1692 else if (!strcmp (proto_str, "DTLS"))
1693 *proto = VPPCOM_PROTO_DTLS;
1694 else if (!strcmp (proto_str, "dtls"))
1695 *proto = VPPCOM_PROTO_DTLS;
1696 else if (!strcmp (proto_str, "SRTP"))
1697 *proto = VPPCOM_PROTO_SRTP;
1698 else if (!strcmp (proto_str, "srtp"))
1699 *proto = VPPCOM_PROTO_SRTP;
1706 vppcom_session_accept (uint32_t listen_session_handle, vppcom_endpt_t * ep,
1709 u32 client_session_index = ~0, listen_session_index, accept_flags = 0;
1710 vcl_worker_t *wrk = vcl_worker_get_current ();
1711 session_accepted_msg_t accepted_msg;
1712 vcl_session_t *listen_session = 0;
1713 vcl_session_t *client_session = 0;
1714 vcl_session_msg_t *evt;
1720 listen_session = vcl_session_get_w_handle (wrk, listen_session_handle);
1721 if (!listen_session)
1722 return VPPCOM_EBADFD;
1724 listen_session_index = listen_session->session_index;
1725 if ((rv = validate_args_session_accept_ (wrk, listen_session)))
1728 if (clib_fifo_elts (listen_session->accept_evts_fifo))
1730 clib_fifo_sub2 (listen_session->accept_evts_fifo, evt);
1731 accept_flags = evt->flags;
1732 accepted_msg = evt->accepted_msg;
1736 is_nonblocking = vcl_session_has_attr (listen_session,
1737 VCL_SESS_ATTR_NONBLOCK);
1740 if (svm_msg_q_is_empty (wrk->app_event_queue) && is_nonblocking)
1741 return VPPCOM_EAGAIN;
1743 svm_msg_q_wait (wrk->app_event_queue, SVM_MQ_WAIT_EMPTY);
1744 vcl_worker_flush_mq_events (wrk);
1750 client_session_index = vcl_session_accepted_handler (wrk, &accepted_msg,
1751 listen_session_index);
1752 if (client_session_index == VCL_INVALID_SESSION_INDEX)
1753 return VPPCOM_ECONNABORTED;
1755 listen_session = vcl_session_get (wrk, listen_session_index);
1756 client_session = vcl_session_get (wrk, client_session_index);
1758 if (flags & O_NONBLOCK)
1759 vcl_session_set_attr (client_session, VCL_SESS_ATTR_NONBLOCK);
1761 VDBG (1, "listener %u [0x%llx]: Got a connect request! session %u [0x%llx],"
1762 " flags %d, is_nonblocking %u", listen_session->session_index,
1763 listen_session->vpp_handle, client_session_index,
1764 client_session->vpp_handle, flags,
1765 vcl_session_has_attr (client_session, VCL_SESS_ATTR_NONBLOCK));
1769 ep->is_ip4 = client_session->transport.is_ip4;
1770 ep->port = client_session->transport.rmt_port;
1771 if (client_session->transport.is_ip4)
1772 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip4,
1773 sizeof (ip4_address_t));
1775 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip6,
1776 sizeof (ip6_address_t));
1780 "listener %u [0x%llx] accepted %u [0x%llx] peer: %U:%u "
1782 listen_session_handle, listen_session->vpp_handle,
1783 client_session_index, client_session->vpp_handle,
1784 vcl_format_ip46_address, &client_session->transport.rmt_ip,
1785 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1786 clib_net_to_host_u16 (client_session->transport.rmt_port),
1787 vcl_format_ip46_address, &client_session->transport.lcl_ip,
1788 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1789 clib_net_to_host_u16 (client_session->transport.lcl_port));
1790 vcl_evt (VCL_EVT_ACCEPT, client_session, listen_session,
1791 client_session_index);
1794 * Session might have been closed already
1798 if (accept_flags & VCL_ACCEPTED_F_CLOSED)
1799 client_session->session_state = VCL_STATE_VPP_CLOSING;
1800 else if (accept_flags & VCL_ACCEPTED_F_RESET)
1801 client_session->session_state = VCL_STATE_DISCONNECT;
1803 return vcl_session_handle (client_session);
1807 vppcom_session_connect (uint32_t session_handle, vppcom_endpt_t * server_ep)
1809 vcl_worker_t *wrk = vcl_worker_get_current ();
1810 vcl_session_t *session = 0;
1814 session = vcl_session_get_w_handle (wrk, session_handle);
1816 return VPPCOM_EBADFD;
1817 session_index = session->session_index;
1819 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1821 VWRN ("cannot connect epoll session %u!", session->session_index);
1822 return VPPCOM_EBADFD;
1825 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1828 "session %u [0x%llx]: already connected to %U:%d proto %s,"
1830 session->session_index, session->vpp_handle,
1831 vcl_format_ip46_address, &session->transport.rmt_ip,
1832 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1833 clib_net_to_host_u16 (session->transport.rmt_port),
1834 vppcom_proto_str (session->session_type),
1835 vcl_session_state_str (session->session_state));
1839 /* Attempt to connect a connectionless listener */
1840 if (PREDICT_FALSE (session->session_state == VCL_STATE_LISTEN))
1842 if (session->session_type != VPPCOM_PROTO_UDP)
1843 return VPPCOM_EINVAL;
1844 vcl_send_session_unlisten (wrk, session);
1845 session->session_state = VCL_STATE_CLOSED;
1848 session->transport.is_ip4 = server_ep->is_ip4;
1849 vcl_ip_copy_from_ep (&session->transport.rmt_ip, server_ep);
1850 session->transport.rmt_port = server_ep->port;
1851 session->parent_handle = VCL_INVALID_SESSION_HANDLE;
1852 session->flags |= VCL_SESSION_F_CONNECTED;
1854 VDBG (0, "session %u: connecting to peer %U:%d proto %s",
1855 session->session_index, vcl_format_ip46_address,
1856 &session->transport.rmt_ip,
1857 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1858 clib_net_to_host_u16 (session->transport.rmt_port),
1859 vppcom_proto_str (session->session_type));
1861 vcl_send_session_connect (wrk, session);
1863 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK))
1865 /* State set to STATE_UPDATED to ensure the session is not assumed
1866 * to be ready and to also allow the app to close it prior to vpp's
1867 * connected reply. */
1868 session->session_state = VCL_STATE_UPDATED;
1869 return VPPCOM_EINPROGRESS;
1873 * Wait for reply from vpp if blocking
1875 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1876 vcm->cfg.session_timeout);
1878 session = vcl_session_get (wrk, session_index);
1879 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1880 session->vpp_handle, rv ? "failed" : "succeeded");
1886 vppcom_session_stream_connect (uint32_t session_handle,
1887 uint32_t parent_session_handle)
1889 vcl_worker_t *wrk = vcl_worker_get_current ();
1890 vcl_session_t *session, *parent_session;
1891 u32 session_index, parent_session_index;
1894 session = vcl_session_get_w_handle (wrk, session_handle);
1896 return VPPCOM_EBADFD;
1897 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1898 if (!parent_session)
1899 return VPPCOM_EBADFD;
1901 session_index = session->session_index;
1902 parent_session_index = parent_session->session_index;
1903 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1905 VDBG (0, "ERROR: cannot connect epoll session %u!",
1906 session->session_index);
1907 return VPPCOM_EBADFD;
1910 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1913 "session handle %u [0x%llx]: session already "
1914 "connected to session %u [0x%llx] proto %s, state 0x%x (%s)",
1915 session_handle, session->vpp_handle, parent_session_handle,
1916 parent_session->vpp_handle,
1917 vppcom_proto_str (session->session_type), session->session_state,
1918 vcl_session_state_str (session->session_state));
1922 /* Connect to quic session specifics */
1923 session->transport.is_ip4 = parent_session->transport.is_ip4;
1924 session->transport.rmt_ip.ip4.as_u32 = (uint32_t) 1;
1925 session->transport.rmt_port = 0;
1926 session->parent_handle = parent_session->vpp_handle;
1928 VDBG (0, "session handle %u: connecting to session %u [0x%llx]",
1929 session_handle, parent_session_handle, parent_session->vpp_handle);
1932 * Send connect request and wait for reply from vpp
1934 vcl_send_session_connect (wrk, session);
1935 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1936 vcm->cfg.session_timeout);
1938 session->listener_index = parent_session_index;
1939 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1941 parent_session->n_accepted_sessions++;
1943 session = vcl_session_get (wrk, session_index);
1944 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1945 session->vpp_handle, rv ? "failed" : "succeeded");
1951 vppcom_session_read_internal (uint32_t session_handle, void *buf, int n,
1954 vcl_worker_t *wrk = vcl_worker_get_current ();
1955 int rv, n_read = 0, is_nonblocking;
1956 vcl_session_t *s = 0;
1957 svm_fifo_t *rx_fifo;
1962 if (PREDICT_FALSE (!buf))
1963 return VPPCOM_EFAULT;
1965 s = vcl_session_get_w_handle (wrk, session_handle);
1966 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
1967 return VPPCOM_EBADFD;
1969 if (PREDICT_FALSE (!vcl_session_is_open (s)))
1971 VDBG (0, "session %u[0x%llx] is not open! state 0x%x (%s)",
1972 s->session_index, s->vpp_handle, s->session_state,
1973 vcl_session_state_str (s->session_state));
1974 return vcl_session_closed_error (s);
1977 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_RD_SHUTDOWN))
1979 /* Vpp would ack the incoming data and enqueue it for reading.
1980 * So even if SHUT_RD is set, we can still read() the data if
1981 * the session is ready.
1983 if (!vcl_session_read_ready (s))
1989 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
1990 is_ct = vcl_session_is_ct (s);
1991 mq = wrk->app_event_queue;
1992 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
1993 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
1995 if (svm_fifo_is_empty_cons (rx_fifo))
1999 if (vcl_session_is_closing (s))
2000 return vcl_session_closing_error (s);
2002 svm_fifo_unset_event (s->rx_fifo);
2003 svm_fifo_unset_event (rx_fifo);
2004 return VPPCOM_EWOULDBLOCK;
2006 while (svm_fifo_is_empty_cons (rx_fifo))
2008 if (vcl_session_is_closing (s))
2009 return vcl_session_closing_error (s);
2012 svm_fifo_unset_event (s->rx_fifo);
2013 svm_fifo_unset_event (rx_fifo);
2015 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2016 vcl_worker_flush_mq_events (wrk);
2023 rv = app_recv_dgram_raw (rx_fifo, buf, n, &s->transport, 0, peek);
2025 rv = app_recv_stream_raw (rx_fifo, buf, n, 0, peek);
2034 if (svm_fifo_is_empty_cons (rx_fifo))
2037 svm_fifo_unset_event (s->rx_fifo);
2038 svm_fifo_unset_event (rx_fifo);
2039 if (!svm_fifo_is_empty_cons (rx_fifo)
2040 && svm_fifo_set_event (rx_fifo) && is_nonblocking)
2042 vec_add2 (wrk->unhandled_evts_vector, e, 1);
2043 e->event_type = SESSION_IO_EVT_RX;
2044 e->session_index = s->session_index;
2047 else if (PREDICT_FALSE (rv < n && !s->is_dgram))
2049 /* More data enqueued while reading. Try to drain it
2050 * or fill the buffer. Avoid doing that for dgrams */
2056 if (PREDICT_FALSE (svm_fifo_needs_deq_ntf (rx_fifo, n_read)))
2058 svm_fifo_clear_deq_ntf (rx_fifo);
2059 app_send_io_evt_to_vpp (s->vpp_evt_q,
2060 s->rx_fifo->shr->master_session_index,
2061 SESSION_IO_EVT_RX, SVM_Q_WAIT);
2064 VDBG (2, "session %u[0x%llx]: read %d bytes from (%p)", s->session_index,
2065 s->vpp_handle, n_read, rx_fifo);
2071 vppcom_session_read (uint32_t session_handle, void *buf, size_t n)
2073 return (vppcom_session_read_internal (session_handle, buf, n, 0));
2077 vppcom_session_peek (uint32_t session_handle, void *buf, int n)
2079 return (vppcom_session_read_internal (session_handle, buf, n, 1));
2083 vppcom_session_read_segments (uint32_t session_handle,
2084 vppcom_data_segment_t * ds, uint32_t n_segments,
2087 vcl_worker_t *wrk = vcl_worker_get_current ();
2088 int n_read = 0, is_nonblocking;
2089 vcl_session_t *s = 0;
2090 svm_fifo_t *rx_fifo;
2094 s = vcl_session_get_w_handle (wrk, session_handle);
2095 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2096 return VPPCOM_EBADFD;
2098 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2099 return vcl_session_closed_error (s);
2101 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2102 is_ct = vcl_session_is_ct (s);
2103 mq = wrk->app_event_queue;
2104 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
2105 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2107 if (svm_fifo_is_empty_cons (rx_fifo))
2112 svm_fifo_unset_event (s->rx_fifo);
2113 svm_fifo_unset_event (rx_fifo);
2114 return VPPCOM_EWOULDBLOCK;
2116 while (svm_fifo_is_empty_cons (rx_fifo))
2118 if (vcl_session_is_closing (s))
2119 return vcl_session_closing_error (s);
2122 svm_fifo_unset_event (s->rx_fifo);
2123 svm_fifo_unset_event (rx_fifo);
2125 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2126 vcl_worker_flush_mq_events (wrk);
2130 n_read = svm_fifo_segments (rx_fifo, s->rx_bytes_pending,
2131 (svm_fifo_seg_t *) ds, &n_segments, max_bytes);
2133 return VPPCOM_EAGAIN;
2135 if (svm_fifo_max_dequeue_cons (rx_fifo) == n_read)
2138 svm_fifo_unset_event (s->rx_fifo);
2139 svm_fifo_unset_event (rx_fifo);
2140 if (svm_fifo_max_dequeue_cons (rx_fifo) != n_read
2141 && svm_fifo_set_event (rx_fifo)
2142 && vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
2145 vec_add2 (wrk->unhandled_evts_vector, e, 1);
2146 e->event_type = SESSION_IO_EVT_RX;
2147 e->session_index = s->session_index;
2151 s->rx_bytes_pending += n_read;
2156 vppcom_session_free_segments (uint32_t session_handle, uint32_t n_bytes)
2158 vcl_worker_t *wrk = vcl_worker_get_current ();
2162 s = vcl_session_get_w_handle (wrk, session_handle);
2163 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2166 is_ct = vcl_session_is_ct (s);
2167 svm_fifo_dequeue_drop (is_ct ? s->ct_rx_fifo : s->rx_fifo, n_bytes);
2169 ASSERT (s->rx_bytes_pending >= n_bytes);
2170 s->rx_bytes_pending -= n_bytes;
2174 vcl_fifo_is_writeable (svm_fifo_t * f, u32 len, u8 is_dgram)
2176 u32 max_enq = svm_fifo_max_enqueue_prod (f);
2178 return max_enq >= (sizeof (session_dgram_hdr_t) + len);
2184 vppcom_session_write_inline (vcl_worker_t * wrk, vcl_session_t * s, void *buf,
2185 size_t n, u8 is_flush, u8 is_dgram)
2187 int n_write, is_nonblocking;
2188 session_evt_type_t et;
2189 svm_fifo_t *tx_fifo;
2193 /* Accept zero length writes but just return */
2194 if (PREDICT_FALSE (!n))
2197 if (PREDICT_FALSE (!buf))
2198 return VPPCOM_EFAULT;
2200 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2202 VDBG (0, "ERROR: session %u [0x%llx]: cannot write to an epoll"
2203 " session!", s->session_index, s->vpp_handle);
2204 return VPPCOM_EBADFD;
2207 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2209 VDBG (1, "session %u [0x%llx]: is not open! state 0x%x (%s)",
2210 s->session_index, s->vpp_handle, s->session_state,
2211 vcl_session_state_str (s->session_state));
2212 return vcl_session_closed_error (s);;
2215 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_WR_SHUTDOWN))
2217 VDBG (1, "session %u [0x%llx]: is shutdown! state 0x%x (%s)",
2218 s->session_index, s->vpp_handle, s->session_state,
2219 vcl_session_state_str (s->session_state));
2220 return VPPCOM_EPIPE;
2223 is_ct = vcl_session_is_ct (s);
2224 tx_fifo = is_ct ? s->ct_tx_fifo : s->tx_fifo;
2225 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2227 mq = wrk->app_event_queue;
2228 if (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2232 return VPPCOM_EWOULDBLOCK;
2234 while (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2236 svm_fifo_add_want_deq_ntf (tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
2237 if (vcl_session_is_closing (s))
2238 return vcl_session_closing_error (s);
2240 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2241 vcl_worker_flush_mq_events (wrk);
2245 et = SESSION_IO_EVT_TX;
2246 if (is_flush && !is_ct)
2247 et = SESSION_IO_EVT_TX_FLUSH;
2250 n_write = app_send_dgram_raw (tx_fifo, &s->transport,
2251 s->vpp_evt_q, buf, n, et,
2252 0 /* do_evt */ , SVM_Q_WAIT);
2254 n_write = app_send_stream_raw (tx_fifo, s->vpp_evt_q, buf, n, et,
2255 0 /* do_evt */ , SVM_Q_WAIT);
2257 if (svm_fifo_set_event (s->tx_fifo))
2258 app_send_io_evt_to_vpp (
2259 s->vpp_evt_q, s->tx_fifo->shr->master_session_index, et, SVM_Q_WAIT);
2261 /* The underlying fifo segment can run out of memory */
2262 if (PREDICT_FALSE (n_write < 0))
2263 return VPPCOM_EAGAIN;
2265 VDBG (2, "session %u [0x%llx]: wrote %d bytes", s->session_index,
2266 s->vpp_handle, n_write);
2272 vppcom_session_write (uint32_t session_handle, void *buf, size_t n)
2274 vcl_worker_t *wrk = vcl_worker_get_current ();
2277 s = vcl_session_get_w_handle (wrk, session_handle);
2278 if (PREDICT_FALSE (!s))
2279 return VPPCOM_EBADFD;
2281 return vppcom_session_write_inline (wrk, s, buf, n,
2282 0 /* is_flush */ , s->is_dgram ? 1 : 0);
2286 vppcom_session_write_msg (uint32_t session_handle, void *buf, size_t n)
2288 vcl_worker_t *wrk = vcl_worker_get_current ();
2291 s = vcl_session_get_w_handle (wrk, session_handle);
2292 if (PREDICT_FALSE (!s))
2293 return VPPCOM_EBADFD;
2295 return vppcom_session_write_inline (wrk, s, buf, n,
2296 1 /* is_flush */ , s->is_dgram ? 1 : 0);
2299 #define vcl_fifo_rx_evt_valid_or_break(_s) \
2300 if (PREDICT_FALSE (!_s->rx_fifo)) \
2302 if (PREDICT_FALSE (svm_fifo_is_empty (_s->rx_fifo))) \
2304 if (!vcl_session_is_ct (_s)) \
2306 svm_fifo_unset_event (_s->rx_fifo); \
2307 if (svm_fifo_is_empty (_s->rx_fifo)) \
2310 else if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2312 svm_fifo_unset_event (_s->rx_fifo); /* rx evts on actual fifo*/ \
2313 if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2319 vcl_select_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2320 unsigned long n_bits, unsigned long *read_map,
2321 unsigned long *write_map,
2322 unsigned long *except_map, u32 * bits_set)
2324 session_disconnected_msg_t *disconnected_msg;
2325 session_connected_msg_t *connected_msg;
2329 switch (e->event_type)
2331 case SESSION_IO_EVT_RX:
2332 sid = e->session_index;
2333 s = vcl_session_get (wrk, sid);
2334 if (!s || !vcl_session_is_open (s))
2336 vcl_fifo_rx_evt_valid_or_break (s);
2337 if (sid < n_bits && read_map)
2339 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2343 case SESSION_IO_EVT_TX:
2344 sid = e->session_index;
2345 s = vcl_session_get (wrk, sid);
2346 if (!s || !vcl_session_is_open (s))
2348 if (sid < n_bits && write_map)
2350 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2354 case SESSION_CTRL_EVT_ACCEPTED:
2356 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
2358 s = vcl_session_get (wrk, e->session_index);
2361 sid = s->session_index;
2362 if (sid < n_bits && read_map)
2364 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2368 case SESSION_CTRL_EVT_CONNECTED:
2371 connected_msg = (session_connected_msg_t *) e->data;
2372 sid = vcl_session_connected_handler (wrk, connected_msg);
2375 sid = e->session_index;
2376 if (sid == VCL_INVALID_SESSION_INDEX)
2378 if (sid < n_bits && write_map)
2380 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2384 case SESSION_CTRL_EVT_DISCONNECTED:
2385 disconnected_msg = (session_disconnected_msg_t *) e->data;
2386 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
2389 sid = s->session_index;
2390 if (sid < n_bits && except_map)
2392 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2396 case SESSION_CTRL_EVT_RESET:
2397 sid = vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
2398 if (sid < n_bits && except_map)
2400 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2404 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
2405 vcl_session_unlisten_reply_handler (wrk, e->data);
2407 case SESSION_CTRL_EVT_MIGRATED:
2408 vcl_session_migrated_handler (wrk, e->data);
2410 case SESSION_CTRL_EVT_CLEANUP:
2411 vcl_session_cleanup_handler (wrk, e->data);
2413 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
2414 vcl_session_worker_update_reply_handler (wrk, e->data);
2416 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
2417 vcl_session_req_worker_update_handler (wrk, e->data);
2419 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
2420 vcl_session_app_add_segment_handler (wrk, e->data);
2422 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
2423 vcl_session_app_del_segment_handler (wrk, e->data);
2425 case SESSION_CTRL_EVT_APP_WRK_RPC:
2426 vcl_worker_rpc_handler (wrk, e->data);
2429 clib_warning ("unhandled: %u", e->event_type);
2435 vcl_select_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
2436 unsigned long n_bits, unsigned long *read_map,
2437 unsigned long *write_map, unsigned long *except_map,
2438 double time_to_wait, u32 * bits_set)
2440 svm_msg_q_msg_t *msg;
2444 if (svm_msg_q_is_empty (mq))
2451 else if (time_to_wait < 0)
2452 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2455 if (svm_msg_q_timedwait (mq, time_to_wait))
2459 vcl_mq_dequeue_batch (wrk, mq, ~0);
2461 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
2463 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
2464 e = svm_msg_q_msg_data (mq, msg);
2465 vcl_select_handle_mq_event (wrk, e, n_bits, read_map, write_map,
2466 except_map, bits_set);
2467 svm_msg_q_free_msg (mq, msg);
2469 vec_reset_length (wrk->mq_msg_vector);
2470 vcl_handle_pending_wrk_updates (wrk);
2475 vppcom_select_condvar (vcl_worker_t * wrk, int n_bits,
2476 vcl_si_set * read_map, vcl_si_set * write_map,
2477 vcl_si_set * except_map, double time_to_wait,
2480 double wait = 0, start = 0;
2484 wait = time_to_wait;
2485 start = clib_time_now (&wrk->clib_time);
2490 vcl_select_handle_mq (wrk, wrk->app_event_queue, n_bits, read_map,
2491 write_map, except_map, wait, bits_set);
2497 wait = wait - (clib_time_now (&wrk->clib_time) - start);
2505 vppcom_select_eventfd (vcl_worker_t * wrk, int n_bits,
2506 vcl_si_set * read_map, vcl_si_set * write_map,
2507 vcl_si_set * except_map, double time_to_wait,
2510 vcl_mq_evt_conn_t *mqc;
2511 int __clib_unused n_read;
2515 if (PREDICT_FALSE (wrk->api_client_handle == ~0))
2517 vcl_api_retry_attach (wrk);
2521 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
2522 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
2523 vec_len (wrk->mq_events), time_to_wait);
2524 for (i = 0; i < n_mq_evts; i++)
2526 if (PREDICT_FALSE (wrk->mq_events[i].data.u32 == ~0))
2528 vcl_api_handle_disconnect (wrk);
2532 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
2533 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
2534 vcl_select_handle_mq (wrk, mqc->mq, n_bits, read_map, write_map,
2535 except_map, 0, bits_set);
2538 return (n_mq_evts > 0 ? (int) *bits_set : 0);
2542 vppcom_select (int n_bits, vcl_si_set * read_map, vcl_si_set * write_map,
2543 vcl_si_set * except_map, double time_to_wait)
2545 u32 sid, minbits = clib_max (n_bits, BITS (uword)), bits_set = 0;
2546 vcl_worker_t *wrk = vcl_worker_get_current ();
2547 vcl_session_t *s = 0;
2550 if (n_bits && read_map)
2552 clib_bitmap_validate (wrk->rd_bitmap, minbits);
2553 clib_memcpy_fast (wrk->rd_bitmap, read_map,
2554 vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2555 memset (read_map, 0, vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2557 if (n_bits && write_map)
2559 clib_bitmap_validate (wrk->wr_bitmap, minbits);
2560 clib_memcpy_fast (wrk->wr_bitmap, write_map,
2561 vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2562 memset (write_map, 0, vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2564 if (n_bits && except_map)
2566 clib_bitmap_validate (wrk->ex_bitmap, minbits);
2567 clib_memcpy_fast (wrk->ex_bitmap, except_map,
2568 vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2569 memset (except_map, 0, vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2578 clib_bitmap_foreach (sid, wrk->wr_bitmap)
2580 if (!(s = vcl_session_get (wrk, sid)))
2582 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2587 if (vcl_session_write_ready (s))
2589 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2594 svm_fifo_t *txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2595 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF);
2603 clib_bitmap_foreach (sid, wrk->rd_bitmap)
2605 if (!(s = vcl_session_get (wrk, sid)))
2607 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2612 if (vcl_session_read_ready (s))
2614 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2621 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
2623 vcl_select_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i], n_bits,
2624 read_map, write_map, except_map, &bits_set);
2626 vec_reset_length (wrk->unhandled_evts_vector);
2628 if (vcm->cfg.use_mq_eventfd)
2629 vppcom_select_eventfd (wrk, n_bits, read_map, write_map, except_map,
2630 time_to_wait, &bits_set);
2632 vppcom_select_condvar (wrk, n_bits, read_map, write_map, except_map,
2633 time_to_wait, &bits_set);
2639 vep_verify_epoll_chain (vcl_worker_t * wrk, u32 vep_handle)
2641 vppcom_epoll_t *vep;
2642 u32 sh = vep_handle;
2645 if (VPPCOM_DEBUG <= 2)
2648 s = vcl_session_get_w_handle (wrk, vep_handle);
2649 if (PREDICT_FALSE (!s))
2651 VDBG (0, "ERROR: Invalid vep_sh (%u)!", vep_handle);
2654 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP)))
2656 VDBG (0, "ERROR: vep_sh (%u) is not a vep!", vep_handle);
2660 VDBG (0, "vep_sh (%u): Dumping epoll chain\n"
2663 " is_vep_session = %u\n"
2664 " next_sh = 0x%x (%u)\n"
2665 "}\n", vep_handle, s->flags & VCL_SESSION_F_IS_VEP,
2666 s->flags & VCL_SESSION_F_IS_VEP_SESSION, vep->next_sh, vep->next_sh);
2668 for (sh = vep->next_sh; sh != ~0; sh = vep->next_sh)
2670 s = vcl_session_get_w_handle (wrk, sh);
2671 if (PREDICT_FALSE (!s))
2673 VDBG (0, "ERROR: Invalid sh (%u)!", sh);
2676 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2678 VDBG (0, "ERROR: sh (%u) is a vep!", vep_handle);
2680 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2682 VDBG (0, "ERROR: sh (%u) is not a vep session handle!", sh);
2686 if (PREDICT_FALSE (vep->vep_sh != vep_handle))
2687 VDBG (0, "ERROR: session (%u) vep_sh (%u) != vep_sh (%u)!",
2688 sh, s->vep.vep_sh, vep_handle);
2689 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2691 VDBG (0, "vep_sh[%u]: sh 0x%x (%u)\n"
2693 " next_sh = 0x%x (%u)\n"
2694 " prev_sh = 0x%x (%u)\n"
2695 " vep_sh = 0x%x (%u)\n"
2696 " ev.events = 0x%x\n"
2697 " ev.data.u64 = 0x%llx\n"
2700 vep_handle, sh, sh, vep->next_sh, vep->next_sh, vep->prev_sh,
2701 vep->prev_sh, vep->vep_sh, vep->vep_sh, vep->ev.events,
2702 vep->ev.data.u64, vep->et_mask);
2707 VDBG (0, "vep_sh (%u): Dump complete!\n", vep_handle);
2711 vppcom_epoll_create (void)
2713 vcl_worker_t *wrk = vcl_worker_get_current ();
2714 vcl_session_t *vep_session;
2716 vep_session = vcl_session_alloc (wrk);
2718 vep_session->flags |= VCL_SESSION_F_IS_VEP;
2719 vep_session->vep.vep_sh = ~0;
2720 vep_session->vep.next_sh = ~0;
2721 vep_session->vep.prev_sh = ~0;
2722 vep_session->vpp_handle = ~0;
2724 vcl_evt (VCL_EVT_EPOLL_CREATE, vep_session, vep_session->session_index);
2725 VDBG (0, "Created vep_idx %u", vep_session->session_index);
2727 return vcl_session_handle (vep_session);
2731 vppcom_epoll_ctl (uint32_t vep_handle, int op, uint32_t session_handle,
2732 struct epoll_event *event)
2734 vcl_worker_t *wrk = vcl_worker_get_current ();
2735 int rv = VPPCOM_OK, add_evt = 0;
2736 vcl_session_t *vep_session;
2740 if (vep_handle == session_handle)
2742 VDBG (0, "vep_sh == session handle (%u)!", vep_handle);
2743 return VPPCOM_EINVAL;
2746 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
2747 if (PREDICT_FALSE (!vep_session))
2749 VDBG (0, "Invalid vep_sh (%u)!", vep_handle);
2750 return VPPCOM_EBADFD;
2752 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
2754 VDBG (0, "vep_sh (%u) is not a vep!", vep_handle);
2755 return VPPCOM_EINVAL;
2758 ASSERT (vep_session->vep.vep_sh == ~0);
2759 ASSERT (vep_session->vep.prev_sh == ~0);
2761 s = vcl_session_get_w_handle (wrk, session_handle);
2762 if (PREDICT_FALSE (!s))
2764 VDBG (0, "Invalid session_handle (%u)!", session_handle);
2765 return VPPCOM_EBADFD;
2767 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2769 VDBG (0, "session_handle (%u) is a vep!", vep_handle);
2770 return VPPCOM_EINVAL;
2776 if (PREDICT_FALSE (!event))
2778 VDBG (0, "EPOLL_CTL_ADD: NULL pointer to epoll_event structure!");
2779 return VPPCOM_EINVAL;
2781 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2783 VDBG (0, "EPOLL_CTL_ADD: %u already epolled!", s->session_index);
2787 if (vep_session->vep.next_sh != ~0)
2789 vcl_session_t *next_session;
2790 next_session = vcl_session_get_w_handle (wrk,
2791 vep_session->vep.next_sh);
2792 if (PREDICT_FALSE (!next_session))
2794 VDBG (0, "EPOLL_CTL_ADD: Invalid vep.next_sh (%u) on "
2795 "vep_idx (%u)!", vep_session->vep.next_sh, vep_handle);
2796 return VPPCOM_EBADFD;
2798 ASSERT (next_session->vep.prev_sh == vep_handle);
2799 next_session->vep.prev_sh = session_handle;
2801 s->vep.next_sh = vep_session->vep.next_sh;
2802 s->vep.prev_sh = vep_handle;
2803 s->vep.vep_sh = vep_handle;
2804 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2805 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
2807 s->flags &= ~VCL_SESSION_F_IS_VEP;
2808 s->flags |= VCL_SESSION_F_IS_VEP_SESSION;
2809 vep_session->vep.next_sh = session_handle;
2811 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2812 if (txf && (event->events & EPOLLOUT))
2813 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2815 /* Generate EPOLLOUT if tx fifo not full */
2816 if ((event->events & EPOLLOUT) && (vcl_session_write_ready (s) > 0))
2818 session_event_t e = { 0 };
2819 e.event_type = SESSION_IO_EVT_TX;
2820 e.session_index = s->session_index;
2821 vec_add1 (wrk->unhandled_evts_vector, e);
2824 /* Generate EPOLLIN if rx fifo has data */
2825 if ((event->events & EPOLLIN) && (vcl_session_read_ready (s) > 0))
2827 session_event_t e = { 0 };
2828 e.event_type = SESSION_IO_EVT_RX;
2829 e.session_index = s->session_index;
2830 vec_add1 (wrk->unhandled_evts_vector, e);
2831 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2834 if (!add_evt && vcl_session_is_closing (s))
2836 session_event_t e = { 0 };
2837 if (s->session_state == VCL_STATE_VPP_CLOSING)
2838 e.event_type = SESSION_CTRL_EVT_DISCONNECTED;
2840 e.event_type = SESSION_CTRL_EVT_RESET;
2841 e.session_index = s->session_index;
2843 vec_add1 (wrk->unhandled_evts_vector, e);
2845 VDBG (1, "EPOLL_CTL_ADD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2846 vep_handle, session_handle, event->events, event->data.u64);
2847 vcl_evt (VCL_EVT_EPOLL_CTLADD, s, event->events, event->data.u64);
2851 if (PREDICT_FALSE (!event))
2853 VDBG (0, "EPOLL_CTL_MOD: NULL pointer to epoll_event structure!");
2857 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2859 VDBG (0, "sh %u EPOLL_CTL_MOD: not a vep session!", session_handle);
2863 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2865 VDBG (0, "EPOLL_CTL_MOD: sh %u vep_sh (%u) != vep_sh (%u)!",
2866 session_handle, s->vep.vep_sh, vep_handle);
2871 /* Generate EPOLLOUT if session write ready nd event was not on */
2872 if ((event->events & EPOLLOUT) && !(s->vep.ev.events & EPOLLOUT) &&
2873 (vcl_session_write_ready (s) > 0))
2875 session_event_t e = { 0 };
2876 e.event_type = SESSION_IO_EVT_TX;
2877 e.session_index = s->session_index;
2878 vec_add1 (wrk->unhandled_evts_vector, e);
2880 /* Generate EPOLLIN if session read ready and event was not on */
2881 if ((event->events & EPOLLIN) && !(s->vep.ev.events & EPOLLIN) &&
2882 (vcl_session_read_ready (s) > 0))
2884 session_event_t e = { 0 };
2885 e.event_type = SESSION_IO_EVT_RX;
2886 e.session_index = s->session_index;
2887 vec_add1 (wrk->unhandled_evts_vector, e);
2888 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2890 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2892 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2895 if (event->events & EPOLLOUT)
2896 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2898 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2900 VDBG (1, "EPOLL_CTL_MOD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2901 vep_handle, session_handle, event->events, event->data.u64);
2905 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2907 VDBG (0, "EPOLL_CTL_DEL: %u not a vep session!", session_handle);
2911 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2913 VDBG (0, "EPOLL_CTL_DEL: sh %u vep_sh (%u) != vep_sh (%u)!",
2914 session_handle, s->vep.vep_sh, vep_handle);
2919 if (s->vep.prev_sh == vep_handle)
2920 vep_session->vep.next_sh = s->vep.next_sh;
2923 vcl_session_t *prev_session;
2924 prev_session = vcl_session_get_w_handle (wrk, s->vep.prev_sh);
2925 if (PREDICT_FALSE (!prev_session))
2927 VDBG (0, "EPOLL_CTL_DEL: Invalid prev_sh (%u) on sh (%u)!",
2928 s->vep.prev_sh, session_handle);
2929 return VPPCOM_EBADFD;
2931 ASSERT (prev_session->vep.next_sh == session_handle);
2932 prev_session->vep.next_sh = s->vep.next_sh;
2934 if (s->vep.next_sh != ~0)
2936 vcl_session_t *next_session;
2937 next_session = vcl_session_get_w_handle (wrk, s->vep.next_sh);
2938 if (PREDICT_FALSE (!next_session))
2940 VDBG (0, "EPOLL_CTL_DEL: Invalid next_sh (%u) on sh (%u)!",
2941 s->vep.next_sh, session_handle);
2942 return VPPCOM_EBADFD;
2944 ASSERT (next_session->vep.prev_sh == session_handle);
2945 next_session->vep.prev_sh = s->vep.prev_sh;
2948 if (s->vep.lt_next != VCL_INVALID_SESSION_INDEX)
2949 vcl_epoll_lt_del (wrk, s);
2951 memset (&s->vep, 0, sizeof (s->vep));
2952 s->vep.next_sh = ~0;
2953 s->vep.prev_sh = ~0;
2955 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
2956 s->flags &= ~VCL_SESSION_F_IS_VEP_SESSION;
2958 if (vcl_session_is_open (s))
2960 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2962 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2965 VDBG (1, "EPOLL_CTL_DEL: vep_idx %u, sh %u!", vep_handle,
2967 vcl_evt (VCL_EVT_EPOLL_CTLDEL, s, vep_sh);
2971 VDBG (0, "Invalid operation (%d)!", op);
2975 vep_verify_epoll_chain (wrk, vep_handle);
2982 vcl_epoll_wait_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2983 struct epoll_event *events, u32 * num_ev)
2985 session_disconnected_msg_t *disconnected_msg;
2986 session_connected_msg_t *connected_msg;
2987 u32 sid = ~0, session_events;
2988 u64 session_evt_data = ~0;
2992 switch (e->event_type)
2994 case SESSION_IO_EVT_RX:
2995 sid = e->session_index;
2996 s = vcl_session_get (wrk, sid);
2997 if (vcl_session_is_closed (s))
2999 vcl_fifo_rx_evt_valid_or_break (s);
3000 session_events = s->vep.ev.events;
3001 if (!(EPOLLIN & s->vep.ev.events) ||
3002 (s->flags & VCL_SESSION_F_HAS_RX_EVT) ||
3003 (s->vep.lt_next != VCL_INVALID_SESSION_INDEX))
3006 events[*num_ev].events = EPOLLIN;
3007 session_evt_data = s->vep.ev.data.u64;
3008 s->flags |= VCL_SESSION_F_HAS_RX_EVT;
3010 case SESSION_IO_EVT_TX:
3011 sid = e->session_index;
3012 s = vcl_session_get (wrk, sid);
3013 if (!s || !vcl_session_is_open (s))
3015 session_events = s->vep.ev.events;
3016 if (!(EPOLLOUT & session_events))
3019 events[*num_ev].events = EPOLLOUT;
3020 session_evt_data = s->vep.ev.data.u64;
3021 svm_fifo_reset_has_deq_ntf (vcl_session_is_ct (s) ?
3022 s->ct_tx_fifo : s->tx_fifo);
3024 case SESSION_CTRL_EVT_ACCEPTED:
3026 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
3028 s = vcl_session_get (wrk, e->session_index);
3031 session_events = s->vep.ev.events;
3032 sid = s->session_index;
3033 if (!(EPOLLIN & session_events) ||
3034 (s->vep.lt_next != VCL_INVALID_SESSION_INDEX))
3037 events[*num_ev].events = EPOLLIN;
3038 session_evt_data = s->vep.ev.data.u64;
3040 case SESSION_CTRL_EVT_CONNECTED:
3043 connected_msg = (session_connected_msg_t *) e->data;
3044 sid = vcl_session_connected_handler (wrk, connected_msg);
3047 sid = e->session_index;
3048 s = vcl_session_get (wrk, sid);
3049 if (vcl_session_is_closed (s))
3051 session_events = s->vep.ev.events;
3052 /* Generate EPOLLOUT because there's no connected event */
3053 if (!(EPOLLOUT & session_events))
3056 events[*num_ev].events = EPOLLOUT;
3057 session_evt_data = s->vep.ev.data.u64;
3058 if (s->session_state == VCL_STATE_DETACHED)
3059 events[*num_ev].events |= EPOLLHUP;
3061 case SESSION_CTRL_EVT_DISCONNECTED:
3064 disconnected_msg = (session_disconnected_msg_t *) e->data;
3065 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
3069 s = vcl_session_get (wrk, e->session_index);
3070 s->flags &= ~VCL_SESSION_F_PENDING_DISCONNECT;
3072 if (vcl_session_is_closed (s) ||
3073 !(s->flags & VCL_SESSION_F_IS_VEP_SESSION))
3075 if (s && (s->flags & VCL_SESSION_F_PENDING_FREE))
3076 vcl_session_free (wrk, s);
3079 sid = s->session_index;
3080 session_events = s->vep.ev.events;
3082 if (EPOLLRDHUP & session_events)
3084 /* If app can distinguish between RDHUP and HUP,
3085 * we make finer control */
3086 events[*num_ev].events = EPOLLRDHUP;
3087 if (s->flags & VCL_SESSION_F_WR_SHUTDOWN)
3089 events[*num_ev].events |= EPOLLHUP;
3094 events[*num_ev].events = EPOLLHUP;
3096 session_evt_data = s->vep.ev.data.u64;
3099 case SESSION_CTRL_EVT_RESET:
3103 vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
3104 s = vcl_session_get (wrk, sid);
3108 sid = e->session_index;
3109 s = vcl_session_get (wrk, sid);
3110 s->flags &= ~VCL_SESSION_F_PENDING_DISCONNECT;
3112 if (vcl_session_is_closed (s) ||
3113 !(s->flags & VCL_SESSION_F_IS_VEP_SESSION))
3115 if (s && (s->flags & VCL_SESSION_F_PENDING_FREE))
3116 vcl_session_free (wrk, s);
3119 session_events = s->vep.ev.events;
3121 events[*num_ev].events = EPOLLHUP | EPOLLRDHUP;
3122 session_evt_data = s->vep.ev.data.u64;
3124 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
3125 vcl_session_unlisten_reply_handler (wrk, e->data);
3127 case SESSION_CTRL_EVT_MIGRATED:
3128 vcl_session_migrated_handler (wrk, e->data);
3130 case SESSION_CTRL_EVT_CLEANUP:
3131 vcl_session_cleanup_handler (wrk, e->data);
3133 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
3134 vcl_session_req_worker_update_handler (wrk, e->data);
3136 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
3137 vcl_session_worker_update_reply_handler (wrk, e->data);
3139 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
3140 vcl_session_app_add_segment_handler (wrk, e->data);
3142 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
3143 vcl_session_app_del_segment_handler (wrk, e->data);
3145 case SESSION_CTRL_EVT_APP_WRK_RPC:
3146 vcl_worker_rpc_handler (wrk, e->data);
3149 VDBG (0, "unhandled: %u", e->event_type);
3155 events[*num_ev].data.u64 = session_evt_data;
3156 if (EPOLLONESHOT & session_events)
3158 s = vcl_session_get (wrk, sid);
3159 s->vep.ev.events = 0;
3161 else if (!(EPOLLET & session_events))
3163 s = vcl_session_get (wrk, sid);
3164 if (s->vep.lt_next == VCL_INVALID_SESSION_INDEX)
3165 vcl_epoll_lt_add (wrk, s);
3172 vcl_epoll_wait_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
3173 struct epoll_event *events, u32 maxevents,
3174 double wait_for_time, u32 * num_ev)
3176 svm_msg_q_msg_t *msg;
3180 if (vec_len (wrk->mq_msg_vector) && svm_msg_q_is_empty (mq))
3181 goto handle_dequeued;
3183 if (svm_msg_q_is_empty (mq))
3187 else if (wait_for_time < 0)
3188 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
3191 if (svm_msg_q_timedwait (mq, wait_for_time / 1e3))
3195 ASSERT (maxevents > *num_ev);
3196 vcl_mq_dequeue_batch (wrk, mq, ~0);
3199 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
3201 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
3202 e = svm_msg_q_msg_data (mq, msg);
3203 if (*num_ev < maxevents)
3204 vcl_epoll_wait_handle_mq_event (wrk, e, events, num_ev);
3206 vcl_handle_mq_event (wrk, e);
3207 svm_msg_q_free_msg (mq, msg);
3209 vec_reset_length (wrk->mq_msg_vector);
3210 vcl_handle_pending_wrk_updates (wrk);
3215 vppcom_epoll_wait_condvar (vcl_worker_t *wrk, struct epoll_event *events,
3216 int maxevents, u32 n_evts, double timeout_ms)
3223 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3228 vcl_epoll_wait_handle_mq (wrk, wrk->app_event_queue, events, maxevents,
3229 timeout_ms, &n_evts);
3230 if (n_evts || !timeout_ms)
3233 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3239 vppcom_epoll_wait_eventfd (vcl_worker_t *wrk, struct epoll_event *events,
3240 int maxevents, u32 n_evts, double timeout_ms)
3242 int __clib_unused n_read;
3243 vcl_mq_evt_conn_t *mqc;
3248 if (PREDICT_FALSE (wrk->api_client_handle == ~0))
3250 vcl_api_retry_attach (wrk);
3254 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
3258 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3263 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
3264 vec_len (wrk->mq_events), timeout_ms);
3267 VDBG (0, "epoll_wait error %u", errno);
3271 for (i = 0; i < n_mq_evts; i++)
3273 if (PREDICT_FALSE (wrk->mq_events[i].data.u32 == ~0))
3275 /* api socket was closed */
3276 vcl_api_handle_disconnect (wrk);
3280 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
3281 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
3282 vcl_epoll_wait_handle_mq (wrk, mqc->mq, events, maxevents, 0,
3286 if (n_evts || !timeout_ms)
3289 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3295 vcl_epoll_wait_handle_lt (vcl_worker_t *wrk, struct epoll_event *events,
3296 int maxevents, u32 *n_evts)
3298 u32 add_event = 0, next;
3303 ASSERT (wrk->ep_lt_current != VCL_INVALID_SESSION_INDEX);
3304 if (*n_evts >= maxevents)
3307 next = wrk->ep_lt_current;
3310 s = vcl_session_get (wrk, next);
3311 next = s->vep.lt_next;
3313 if ((s->vep.ev.events & EPOLLIN) && (rv = vcl_session_read_ready (s)))
3316 events[*n_evts].events |= rv > 0 ? EPOLLIN : EPOLLHUP | EPOLLRDHUP;
3317 evt_data = s->vep.ev.data.u64;
3319 if ((s->vep.ev.events & EPOLLOUT) && (rv = vcl_session_write_ready (s)))
3322 events[*n_evts].events |= rv > 0 ? EPOLLOUT : EPOLLHUP | EPOLLRDHUP;
3323 evt_data = s->vep.ev.data.u64;
3325 if (!add_event && s->session_state > VCL_STATE_READY)
3328 events[*n_evts].events |= EPOLLHUP | EPOLLRDHUP;
3329 evt_data = s->vep.ev.data.u64;
3333 events[*n_evts].data.u64 = evt_data;
3336 if (EPOLLONESHOT & s->vep.ev.events)
3337 s->vep.ev.events = 0;
3338 if (*n_evts == maxevents)
3340 wrk->ep_lt_current = next;
3346 vcl_epoll_lt_del (wrk, s);
3347 if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX)
3351 while (next != wrk->ep_lt_current);
3355 vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
3356 int maxevents, double wait_for_time)
3358 vcl_worker_t *wrk = vcl_worker_get_current ();
3359 vcl_session_t *vep_session;
3363 if (PREDICT_FALSE (maxevents <= 0))
3365 VDBG (0, "ERROR: Invalid maxevents (%d)!", maxevents);
3366 return VPPCOM_EINVAL;
3369 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
3371 return VPPCOM_EBADFD;
3373 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
3375 VDBG (0, "ERROR: vep_idx (%u) is not a vep!", vep_handle);
3376 return VPPCOM_EINVAL;
3379 if (vec_len (wrk->unhandled_evts_vector))
3381 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
3383 vcl_epoll_wait_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i],
3385 if (n_evts == maxevents)
3387 vec_delete (wrk->unhandled_evts_vector, i + 1, 0);
3391 vec_reset_length (wrk->unhandled_evts_vector);
3394 if (PREDICT_FALSE (wrk->ep_lt_current != VCL_INVALID_SESSION_INDEX))
3395 vcl_epoll_wait_handle_lt (wrk, events, maxevents, &n_evts);
3397 /* Request to only drain unhandled */
3398 if ((int) wait_for_time == -2)
3402 if (vcm->cfg.use_mq_eventfd)
3403 n_evts = vppcom_epoll_wait_eventfd (wrk, events, maxevents, n_evts,
3406 n_evts = vppcom_epoll_wait_condvar (wrk, events, maxevents, n_evts,
3413 vppcom_session_attr (uint32_t session_handle, uint32_t op,
3414 void *buffer, uint32_t * buflen)
3416 vcl_worker_t *wrk = vcl_worker_get_current ();
3417 u32 *flags = buffer;
3418 vppcom_endpt_t *ep = buffer;
3419 transport_endpt_attr_t tea;
3420 vcl_session_t *session;
3423 session = vcl_session_get_w_handle (wrk, session_handle);
3425 return VPPCOM_EBADFD;
3429 case VPPCOM_ATTR_GET_NREAD:
3430 rv = vcl_session_read_ready (session);
3431 VDBG (2, "VPPCOM_ATTR_GET_NREAD: sh %u, nread = %d", session_handle,
3435 case VPPCOM_ATTR_GET_NWRITE:
3436 rv = vcl_session_write_ready (session);
3437 VDBG (2, "VPPCOM_ATTR_GET_NWRITE: sh %u, nwrite = %d", session_handle,
3441 case VPPCOM_ATTR_GET_FLAGS:
3442 if (PREDICT_TRUE (buffer && buflen && (*buflen >= sizeof (*flags))))
3446 (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK) ?
3448 *buflen = sizeof (*flags);
3449 VDBG (2, "VPPCOM_ATTR_GET_FLAGS: sh %u, flags = 0x%08x, "
3450 "is_nonblocking = %u", session_handle, *flags,
3451 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3457 case VPPCOM_ATTR_SET_FLAGS:
3458 if (PREDICT_TRUE (buffer && buflen && (*buflen == sizeof (*flags))))
3460 if (*flags & O_NONBLOCK)
3461 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
3463 vcl_session_clear_attr (session, VCL_SESS_ATTR_NONBLOCK);
3465 VDBG (2, "VPPCOM_ATTR_SET_FLAGS: sh %u, flags = 0x%08x,"
3466 " is_nonblocking = %u", session_handle, *flags,
3467 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3473 case VPPCOM_ATTR_GET_PEER_ADDR:
3474 if (PREDICT_TRUE (buffer && buflen &&
3475 (*buflen >= sizeof (*ep)) && ep->ip))
3477 ep->is_ip4 = session->transport.is_ip4;
3478 ep->port = session->transport.rmt_port;
3479 if (session->transport.is_ip4)
3480 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
3481 sizeof (ip4_address_t));
3483 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
3484 sizeof (ip6_address_t));
3485 *buflen = sizeof (*ep);
3487 "VPPCOM_ATTR_GET_PEER_ADDR: sh %u, is_ip4 = %u, "
3488 "addr = %U, port %u",
3489 session_handle, ep->is_ip4, vcl_format_ip46_address,
3490 &session->transport.rmt_ip,
3491 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3492 clib_net_to_host_u16 (ep->port));
3498 case VPPCOM_ATTR_GET_LCL_ADDR:
3499 if (PREDICT_TRUE (buffer && buflen &&
3500 (*buflen >= sizeof (*ep)) && ep->ip))
3502 ep->is_ip4 = session->transport.is_ip4;
3503 ep->port = session->transport.lcl_port;
3504 if (session->transport.is_ip4)
3505 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip4,
3506 sizeof (ip4_address_t));
3508 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip6,
3509 sizeof (ip6_address_t));
3510 *buflen = sizeof (*ep);
3512 "VPPCOM_ATTR_GET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3514 session_handle, ep->is_ip4, vcl_format_ip46_address,
3515 &session->transport.lcl_ip,
3516 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3517 clib_net_to_host_u16 (ep->port));
3523 case VPPCOM_ATTR_SET_LCL_ADDR:
3524 if (PREDICT_TRUE (buffer && buflen &&
3525 (*buflen >= sizeof (*ep)) && ep->ip))
3527 session->transport.is_ip4 = ep->is_ip4;
3528 session->transport.lcl_port = ep->port;
3529 vcl_ip_copy_from_ep (&session->transport.lcl_ip, ep);
3530 *buflen = sizeof (*ep);
3532 "VPPCOM_ATTR_SET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3534 session_handle, ep->is_ip4, vcl_format_ip46_address,
3535 &session->transport.lcl_ip,
3536 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3537 clib_net_to_host_u16 (ep->port));
3543 case VPPCOM_ATTR_GET_LIBC_EPFD:
3544 rv = session->libc_epfd;
3545 VDBG (2, "VPPCOM_ATTR_GET_LIBC_EPFD: libc_epfd %d", rv);
3548 case VPPCOM_ATTR_SET_LIBC_EPFD:
3549 if (PREDICT_TRUE (buffer && buflen &&
3550 (*buflen == sizeof (session->libc_epfd))))
3552 session->libc_epfd = *(int *) buffer;
3553 *buflen = sizeof (session->libc_epfd);
3555 VDBG (2, "VPPCOM_ATTR_SET_LIBC_EPFD: libc_epfd %d, buflen %d",
3556 session->libc_epfd, *buflen);
3562 case VPPCOM_ATTR_GET_PROTOCOL:
3563 if (buffer && buflen && (*buflen >= sizeof (int)))
3565 *(int *) buffer = session->session_type;
3566 *buflen = sizeof (int);
3568 VDBG (2, "VPPCOM_ATTR_GET_PROTOCOL: %d (%s), buflen %d",
3569 *(int *) buffer, *(int *) buffer ? "UDP" : "TCP", *buflen);
3575 case VPPCOM_ATTR_GET_LISTEN:
3576 if (buffer && buflen && (*buflen >= sizeof (int)))
3578 *(int *) buffer = vcl_session_has_attr (session,
3579 VCL_SESS_ATTR_LISTEN);
3580 *buflen = sizeof (int);
3582 VDBG (2, "VPPCOM_ATTR_GET_LISTEN: %d, buflen %d", *(int *) buffer,
3589 case VPPCOM_ATTR_GET_ERROR:
3590 if (buffer && buflen && (*buflen >= sizeof (int)))
3592 *(int *) buffer = 0;
3593 *buflen = sizeof (int);
3595 VDBG (2, "VPPCOM_ATTR_GET_ERROR: %d, buflen %d, #VPP-TBD#",
3596 *(int *) buffer, *buflen);
3602 case VPPCOM_ATTR_GET_TX_FIFO_LEN:
3603 if (buffer && buflen && (*buflen >= sizeof (u32)))
3607 *(size_t *) buffer = (session->sndbuf_size ? session->sndbuf_size :
3609 svm_fifo_size (session->tx_fifo) :
3610 vcm->cfg.tx_fifo_size);
3611 *buflen = sizeof (u32);
3613 VDBG (2, "VPPCOM_ATTR_GET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3614 " #VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer,
3621 case VPPCOM_ATTR_SET_DSCP:
3622 if (buffer && buflen && (*buflen >= sizeof (u8)))
3624 session->dscp = *(u8 *) buffer;
3626 VDBG (2, "VPPCOM_ATTR_SET_DSCP: %u (0x%x), buflen %d,",
3627 *(u8 *) buffer, *(u8 *) buffer, *buflen);
3633 case VPPCOM_ATTR_SET_TX_FIFO_LEN:
3634 if (buffer && buflen && (*buflen == sizeof (u32)))
3637 session->sndbuf_size = *(u32 *) buffer;
3638 VDBG (2, "VPPCOM_ATTR_SET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3639 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3646 case VPPCOM_ATTR_GET_RX_FIFO_LEN:
3647 if (buffer && buflen && (*buflen >= sizeof (u32)))
3651 *(size_t *) buffer = (session->rcvbuf_size ? session->rcvbuf_size :
3653 svm_fifo_size (session->rx_fifo) :
3654 vcm->cfg.rx_fifo_size);
3655 *buflen = sizeof (u32);
3657 VDBG (2, "VPPCOM_ATTR_GET_RX_FIFO_LEN: %u (0x%x), buflen %d, "
3658 "#VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer, *buflen);
3664 case VPPCOM_ATTR_SET_RX_FIFO_LEN:
3665 if (buffer && buflen && (*buflen == sizeof (u32)))
3668 session->rcvbuf_size = *(u32 *) buffer;
3669 VDBG (2, "VPPCOM_ATTR_SET_RX_FIFO_LEN: %u (0x%x), buflen %d,"
3670 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3677 case VPPCOM_ATTR_GET_REUSEADDR:
3678 if (buffer && buflen && (*buflen >= sizeof (int)))
3681 *(int *) buffer = vcl_session_has_attr (session,
3682 VCL_SESS_ATTR_REUSEADDR);
3683 *buflen = sizeof (int);
3685 VDBG (2, "VPPCOM_ATTR_GET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3686 *(int *) buffer, *buflen);
3692 case VPPCOM_ATTR_SET_REUSEADDR:
3693 if (buffer && buflen && (*buflen == sizeof (int)) &&
3694 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3697 if (*(int *) buffer)
3698 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEADDR);
3700 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEADDR);
3702 VDBG (2, "VPPCOM_ATTR_SET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3703 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEADDR),
3710 case VPPCOM_ATTR_GET_REUSEPORT:
3711 if (buffer && buflen && (*buflen >= sizeof (int)))
3714 *(int *) buffer = vcl_session_has_attr (session,
3715 VCL_SESS_ATTR_REUSEPORT);
3716 *buflen = sizeof (int);
3718 VDBG (2, "VPPCOM_ATTR_GET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3719 *(int *) buffer, *buflen);
3725 case VPPCOM_ATTR_SET_REUSEPORT:
3726 if (buffer && buflen && (*buflen == sizeof (int)) &&
3727 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3730 if (*(int *) buffer)
3731 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEPORT);
3733 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEPORT);
3735 VDBG (2, "VPPCOM_ATTR_SET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3736 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEPORT),
3743 case VPPCOM_ATTR_GET_BROADCAST:
3744 if (buffer && buflen && (*buflen >= sizeof (int)))
3747 *(int *) buffer = vcl_session_has_attr (session,
3748 VCL_SESS_ATTR_BROADCAST);
3749 *buflen = sizeof (int);
3751 VDBG (2, "VPPCOM_ATTR_GET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3752 *(int *) buffer, *buflen);
3758 case VPPCOM_ATTR_SET_BROADCAST:
3759 if (buffer && buflen && (*buflen == sizeof (int)))
3762 if (*(int *) buffer)
3763 vcl_session_set_attr (session, VCL_SESS_ATTR_BROADCAST);
3765 vcl_session_clear_attr (session, VCL_SESS_ATTR_BROADCAST);
3767 VDBG (2, "VPPCOM_ATTR_SET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3768 vcl_session_has_attr (session, VCL_SESS_ATTR_BROADCAST),
3775 case VPPCOM_ATTR_GET_V6ONLY:
3776 if (buffer && buflen && (*buflen >= sizeof (int)))
3779 *(int *) buffer = vcl_session_has_attr (session,
3780 VCL_SESS_ATTR_V6ONLY);
3781 *buflen = sizeof (int);
3783 VDBG (2, "VPPCOM_ATTR_GET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3784 *(int *) buffer, *buflen);
3790 case VPPCOM_ATTR_SET_V6ONLY:
3791 if (buffer && buflen && (*buflen == sizeof (int)))
3794 if (*(int *) buffer)
3795 vcl_session_set_attr (session, VCL_SESS_ATTR_V6ONLY);
3797 vcl_session_clear_attr (session, VCL_SESS_ATTR_V6ONLY);
3799 VDBG (2, "VPPCOM_ATTR_SET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3800 vcl_session_has_attr (session, VCL_SESS_ATTR_V6ONLY),
3807 case VPPCOM_ATTR_GET_KEEPALIVE:
3808 if (buffer && buflen && (*buflen >= sizeof (int)))
3811 *(int *) buffer = vcl_session_has_attr (session,
3812 VCL_SESS_ATTR_KEEPALIVE);
3813 *buflen = sizeof (int);
3815 VDBG (2, "VPPCOM_ATTR_GET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3816 *(int *) buffer, *buflen);
3822 case VPPCOM_ATTR_SET_KEEPALIVE:
3823 if (buffer && buflen && (*buflen == sizeof (int)))
3826 if (*(int *) buffer)
3827 vcl_session_set_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3829 vcl_session_clear_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3831 VDBG (2, "VPPCOM_ATTR_SET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3832 vcl_session_has_attr (session, VCL_SESS_ATTR_KEEPALIVE),
3839 case VPPCOM_ATTR_GET_TCP_NODELAY:
3840 if (buffer && buflen && (*buflen >= sizeof (int)))
3843 *(int *) buffer = vcl_session_has_attr (session,
3844 VCL_SESS_ATTR_TCP_NODELAY);
3845 *buflen = sizeof (int);
3847 VDBG (2, "VPPCOM_ATTR_GET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3848 *(int *) buffer, *buflen);
3854 case VPPCOM_ATTR_SET_TCP_NODELAY:
3855 if (buffer && buflen && (*buflen == sizeof (int)))
3858 if (*(int *) buffer)
3859 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3861 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3863 VDBG (2, "VPPCOM_ATTR_SET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3864 vcl_session_has_attr (session, VCL_SESS_ATTR_TCP_NODELAY),
3871 case VPPCOM_ATTR_GET_TCP_KEEPIDLE:
3872 if (buffer && buflen && (*buflen >= sizeof (int)))
3875 *(int *) buffer = vcl_session_has_attr (session,
3876 VCL_SESS_ATTR_TCP_KEEPIDLE);
3877 *buflen = sizeof (int);
3879 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3880 *(int *) buffer, *buflen);
3886 case VPPCOM_ATTR_SET_TCP_KEEPIDLE:
3887 if (buffer && buflen && (*buflen == sizeof (int)))
3890 if (*(int *) buffer)
3891 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3893 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3895 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3896 vcl_session_has_attr (session,
3897 VCL_SESS_ATTR_TCP_KEEPIDLE), *buflen);
3903 case VPPCOM_ATTR_GET_TCP_KEEPINTVL:
3904 if (buffer && buflen && (*buflen >= sizeof (int)))
3907 *(int *) buffer = vcl_session_has_attr (session,
3908 VCL_SESS_ATTR_TCP_KEEPINTVL);
3909 *buflen = sizeof (int);
3911 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3912 *(int *) buffer, *buflen);
3918 case VPPCOM_ATTR_SET_TCP_KEEPINTVL:
3919 if (buffer && buflen && (*buflen == sizeof (int)))
3922 if (*(int *) buffer)
3923 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3925 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3927 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3928 vcl_session_has_attr (session,
3929 VCL_SESS_ATTR_TCP_KEEPINTVL), *buflen);
3935 case VPPCOM_ATTR_GET_TCP_USER_MSS:
3936 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
3942 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3943 tea.mss = *(u32 *) buffer;
3944 if (vcl_session_transport_attr (wrk, session, 1 /* is_get */, &tea))
3945 rv = VPPCOM_ENOPROTOOPT;
3949 *(u32 *) buffer = tea.mss;
3950 *buflen = sizeof (int);
3953 VDBG (2, "VPPCOM_ATTR_GET_TCP_USER_MSS: %d, buflen %d", *(int *) buffer,
3957 case VPPCOM_ATTR_SET_TCP_USER_MSS:
3958 if (!(buffer && buflen && (*buflen == sizeof (u32))))
3964 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3965 tea.mss = *(u32 *) buffer;
3966 if (vcl_session_transport_attr (wrk, session, 0 /* is_get */, &tea))
3967 rv = VPPCOM_ENOPROTOOPT;
3969 VDBG (2, "VPPCOM_ATTR_SET_TCP_USER_MSS: %u, buflen %d", tea.mss,
3973 case VPPCOM_ATTR_SET_CONNECTED:
3974 session->flags |= VCL_SESSION_F_CONNECTED;
3977 case VPPCOM_ATTR_SET_CKPAIR:
3978 if (!(buffer && buflen && (*buflen == sizeof (int))) ||
3979 !vcl_session_has_crypto (session))
3984 if (!session->ext_config)
3986 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_CRYPTO,
3987 sizeof (transport_endpt_ext_cfg_t));
3989 else if (session->ext_config->type != TRANSPORT_ENDPT_EXT_CFG_CRYPTO)
3995 session->ext_config->crypto.ckpair_index = *(uint32_t *) buffer;
3998 case VPPCOM_ATTR_SET_VRF:
3999 if (!(buffer && buflen && (*buflen == sizeof (u32))))
4004 session->vrf = *(u32 *) buffer;
4007 case VPPCOM_ATTR_GET_VRF:
4008 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
4013 *(u32 *) buffer = session->vrf;
4014 *buflen = sizeof (u32);
4017 case VPPCOM_ATTR_GET_DOMAIN:
4018 if (!(buffer && buflen && (*buflen >= sizeof (int))))
4024 if (session->transport.is_ip4)
4025 *(int *) buffer = AF_INET;
4027 *(int *) buffer = AF_INET6;
4028 *buflen = sizeof (int);
4030 VDBG (2, "VPPCOM_ATTR_GET_DOMAIN: %d, buflen %u", *(int *) buffer,
4034 case VPPCOM_ATTR_SET_ENDPT_EXT_CFG:
4035 if (!(buffer && buflen && (*buflen > 0)))
4040 if (session->ext_config)
4045 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_NONE,
4046 *buflen + sizeof (u32));
4047 clib_memcpy (session->ext_config->data, buffer, *buflen);
4048 session->ext_config->len = *buflen;
4060 vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
4061 uint32_t buflen, int flags, vppcom_endpt_t * ep)
4063 vcl_worker_t *wrk = vcl_worker_get_current ();
4064 vcl_session_t *session;
4068 rv = vppcom_session_read (session_handle, buffer, buflen);
4069 else if (flags & MSG_PEEK)
4070 rv = vppcom_session_peek (session_handle, buffer, buflen);
4073 VDBG (0, "Unsupport flags for recvfrom %d", flags);
4074 return VPPCOM_EAFNOSUPPORT;
4079 session = vcl_session_get_w_handle (wrk, session_handle);
4080 if (session->transport.is_ip4)
4081 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
4082 sizeof (ip4_address_t));
4084 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
4085 sizeof (ip6_address_t));
4086 ep->is_ip4 = session->transport.is_ip4;
4087 ep->port = session->transport.rmt_port;
4094 vppcom_session_sendto (uint32_t session_handle, void *buffer,
4095 uint32_t buflen, int flags, vppcom_endpt_t * ep)
4097 vcl_worker_t *wrk = vcl_worker_get_current ();
4100 s = vcl_session_get_w_handle (wrk, session_handle);
4101 if (PREDICT_FALSE (!s))
4102 return VPPCOM_EBADFD;
4106 if (!vcl_session_is_cl (s))
4107 return VPPCOM_EINVAL;
4109 s->transport.is_ip4 = ep->is_ip4;
4110 s->transport.rmt_port = ep->port;
4111 vcl_ip_copy_from_ep (&s->transport.rmt_ip, ep);
4113 /* Session not connected/bound in vpp. Create it by 'connecting' it */
4114 if (PREDICT_FALSE (s->session_state == VCL_STATE_CLOSED))
4116 u32 session_index = s->session_index;
4117 f64 timeout = vcm->cfg.session_timeout;
4120 vcl_send_session_connect (wrk, s);
4121 rv = vppcom_wait_for_session_state_change (session_index,
4126 s = vcl_session_get (wrk, session_index);
4132 // TBD check the flags and do the right thing
4133 VDBG (2, "handling flags 0x%u (%d) not implemented yet.", flags, flags);
4136 return (vppcom_session_write_inline (wrk, s, buffer, buflen, 1,
4137 s->is_dgram ? 1 : 0));
4141 vppcom_poll (vcl_poll_t * vp, uint32_t n_sids, double wait_for_time)
4143 vcl_worker_t *wrk = vcl_worker_get_current ();
4144 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
4145 u32 i, keep_trying = 1;
4146 svm_msg_q_msg_t msg;
4150 VDBG (3, "vp %p, nsids %u, wait_for_time %f", vp, n_sids, wait_for_time);
4153 return VPPCOM_EFAULT;
4157 vcl_session_t *session;
4159 /* Dequeue all events and drop all unhandled io events */
4160 while (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0) == 0)
4162 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
4163 vcl_handle_mq_event (wrk, e);
4164 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
4166 vec_reset_length (wrk->unhandled_evts_vector);
4168 for (i = 0; i < n_sids; i++)
4170 session = vcl_session_get (wrk, vp[i].sh);
4173 vp[i].revents = POLLHUP;
4180 if (POLLIN & vp[i].events)
4182 rv = vcl_session_read_ready (session);
4185 vp[i].revents |= POLLIN;
4192 case VPPCOM_ECONNRESET:
4193 vp[i].revents = POLLHUP;
4197 vp[i].revents = POLLERR;
4204 if (POLLOUT & vp[i].events)
4206 rv = vcl_session_write_ready (session);
4209 vp[i].revents |= POLLOUT;
4216 case VPPCOM_ECONNRESET:
4217 vp[i].revents = POLLHUP;
4221 vp[i].revents = POLLERR;
4228 if (0) // Note "done:" label used by VCL_SESSION_LOCK_AND_GET()
4230 vp[i].revents = POLLNVAL;
4234 if (wait_for_time != -1)
4235 keep_trying = (clib_time_now (&wrk->clib_time) <= timeout) ? 1 : 0;
4237 while ((num_ev == 0) && keep_trying);
4243 vppcom_mq_epoll_fd (void)
4245 vcl_worker_t *wrk = vcl_worker_get_current ();
4246 return wrk->mqs_epfd;
4250 vppcom_session_index (vcl_session_handle_t session_handle)
4252 return session_handle & 0xFFFFFF;
4256 vppcom_session_worker (vcl_session_handle_t session_handle)
4258 return session_handle >> 24;
4262 vppcom_worker_register (void)
4264 if (!vcl_worker_alloc_and_init ())
4265 return VPPCOM_EEXIST;
4267 if (vcl_worker_register_with_vpp ())
4268 return VPPCOM_EEXIST;
4274 vppcom_worker_unregister (void)
4276 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
4277 vcl_set_worker_index (~0);
4281 vppcom_worker_index_set (int index)
4283 vcl_set_worker_index (index);
4287 vppcom_worker_index (void)
4289 return vcl_get_worker_index ();
4293 vppcom_worker_mqs_epfd (void)
4295 vcl_worker_t *wrk = vcl_worker_get_current ();
4296 if (!vcm->cfg.use_mq_eventfd)
4298 return wrk->mqs_epfd;
4302 vppcom_session_is_connectable_listener (uint32_t session_handle)
4304 vcl_session_t *session;
4305 vcl_worker_t *wrk = vcl_worker_get_current ();
4306 session = vcl_session_get_w_handle (wrk, session_handle);
4308 return VPPCOM_EBADFD;
4309 return vcl_session_is_connectable_listener (wrk, session);
4313 vppcom_session_listener (uint32_t session_handle)
4315 vcl_worker_t *wrk = vcl_worker_get_current ();
4316 vcl_session_t *listen_session, *session;
4317 session = vcl_session_get_w_handle (wrk, session_handle);
4319 return VPPCOM_EBADFD;
4320 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
4321 return VPPCOM_EBADFD;
4322 listen_session = vcl_session_get_w_handle (wrk, session->listener_index);
4323 if (!listen_session)
4324 return VPPCOM_EBADFD;
4325 return vcl_session_handle (listen_session);
4329 vppcom_session_n_accepted (uint32_t session_handle)
4331 vcl_worker_t *wrk = vcl_worker_get_current ();
4332 vcl_session_t *session = vcl_session_get_w_handle (wrk, session_handle);
4334 return VPPCOM_EBADFD;
4335 return session->n_accepted_sessions;
4339 vppcom_proto_str (vppcom_proto_t proto)
4341 char const *proto_str;
4345 case VPPCOM_PROTO_TCP:
4348 case VPPCOM_PROTO_UDP:
4351 case VPPCOM_PROTO_TLS:
4354 case VPPCOM_PROTO_QUIC:
4357 case VPPCOM_PROTO_DTLS:
4360 case VPPCOM_PROTO_SRTP:
4364 proto_str = "UNKNOWN";
4371 vppcom_retval_str (int retval)
4382 st = "VPPCOM_EAGAIN";
4386 st = "VPPCOM_EFAULT";
4390 st = "VPPCOM_ENOMEM";
4394 st = "VPPCOM_EINVAL";
4398 st = "VPPCOM_EBADFD";
4401 case VPPCOM_EAFNOSUPPORT:
4402 st = "VPPCOM_EAFNOSUPPORT";
4405 case VPPCOM_ECONNABORTED:
4406 st = "VPPCOM_ECONNABORTED";
4409 case VPPCOM_ECONNRESET:
4410 st = "VPPCOM_ECONNRESET";
4413 case VPPCOM_ENOTCONN:
4414 st = "VPPCOM_ENOTCONN";
4417 case VPPCOM_ECONNREFUSED:
4418 st = "VPPCOM_ECONNREFUSED";
4421 case VPPCOM_ETIMEDOUT:
4422 st = "VPPCOM_ETIMEDOUT";
4425 case VPPCOM_EADDRINUSE:
4426 st = "VPPCOM_EADDRINUSE";
4430 st = "UNKNOWN_STATE";
4438 vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
4440 if (vcm->cfg.vpp_app_socket_api)
4441 return vcl_sapi_add_cert_key_pair (ckpair);
4443 return vcl_bapi_add_cert_key_pair (ckpair);
4447 vppcom_del_cert_key_pair (uint32_t ckpair_index)
4449 if (vcm->cfg.vpp_app_socket_api)
4450 return vcl_sapi_del_cert_key_pair (ckpair_index);
4452 return vcl_bapi_del_cert_key_pair (ckpair_index);
4456 vppcom_session_get_error (uint32_t session_handle)
4458 vcl_worker_t *wrk = vcl_worker_get_current ();
4459 vcl_session_t *session = 0;
4461 session = vcl_session_get_w_handle (wrk, session_handle);
4463 return VPPCOM_EBADFD;
4465 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
4467 VWRN ("epoll session %u! will not have connect", session->session_index);
4468 return VPPCOM_EBADFD;
4471 if (session->vpp_error == SESSION_E_PORTINUSE)
4472 return VPPCOM_EADDRINUSE;
4473 else if (session->vpp_error == SESSION_E_REFUSED)
4474 return VPPCOM_ECONNREFUSED;
4475 else if (session->vpp_error != SESSION_E_NONE)
4476 return VPPCOM_EFAULT;
4482 * fd.io coding-style-patch-verification: ON
4485 * eval: (c-set-style "gnu")