2 * Copyright (c) 2017-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 #include <vcl/vppcom.h>
19 #include <vcl/vcl_debug.h>
20 #include <vcl/vcl_private.h>
21 #include <svm/fifo_segment.h>
23 __thread uword __vcl_worker_index = ~0;
26 vcl_mq_dequeue_batch (vcl_worker_t * wrk, svm_msg_q_t * mq, u32 n_max_msg)
28 u32 n_msgs = 0, sz, len;
30 while ((sz = svm_msg_q_size (mq)))
32 len = vec_len (wrk->mq_msg_vector);
33 vec_validate (wrk->mq_msg_vector, len + sz - 1);
34 svm_msg_q_sub_raw_batch (mq, wrk->mq_msg_vector + len, sz);
43 vcl_msg_add_ext_config (vcl_session_t *s, uword *offset)
47 c = vcl_segment_alloc_chunk (vcl_vpp_worker_segment_handle (0),
48 0 /* one slice only */, s->ext_config->len,
51 clib_memcpy_fast (c->data, s->ext_config, s->ext_config->len);
55 vcl_send_session_listen (vcl_worker_t * wrk, vcl_session_t * s)
57 app_session_evt_t _app_evt, *app_evt = &_app_evt;
58 session_listen_msg_t *mp;
61 mq = vcl_worker_ctrl_mq (wrk);
62 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_LISTEN);
63 mp = (session_listen_msg_t *) app_evt->evt->data;
64 memset (mp, 0, sizeof (*mp));
65 mp->client_index = wrk->api_client_handle;
66 mp->context = s->session_index;
67 mp->wrk_index = wrk->vpp_wrk_index;
68 mp->is_ip4 = s->transport.is_ip4;
69 clib_memcpy_fast (&mp->ip, &s->transport.lcl_ip, sizeof (mp->ip));
70 mp->port = s->transport.lcl_port;
71 mp->proto = s->session_type;
73 if (s->flags & VCL_SESSION_F_CONNECTED)
74 mp->flags = TRANSPORT_CFG_F_CONNECTED;
76 vcl_msg_add_ext_config (s, &mp->ext_config);
77 app_send_ctrl_evt_to_vpp (mq, app_evt);
80 clib_mem_free (s->ext_config);
86 vcl_send_session_connect (vcl_worker_t * wrk, vcl_session_t * s)
88 app_session_evt_t _app_evt, *app_evt = &_app_evt;
89 session_connect_msg_t *mp;
92 mq = vcl_worker_ctrl_mq (wrk);
93 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_CONNECT);
94 mp = (session_connect_msg_t *) app_evt->evt->data;
95 memset (mp, 0, sizeof (*mp));
96 mp->client_index = wrk->api_client_handle;
97 mp->context = s->session_index;
99 mp->wrk_index = wrk->vpp_wrk_index;
100 mp->is_ip4 = s->transport.is_ip4;
101 mp->parent_handle = s->parent_handle;
102 clib_memcpy_fast (&mp->ip, &s->transport.rmt_ip, sizeof (mp->ip));
103 clib_memcpy_fast (&mp->lcl_ip, &s->transport.lcl_ip, sizeof (mp->lcl_ip));
104 mp->port = s->transport.rmt_port;
105 mp->lcl_port = s->transport.lcl_port;
106 mp->proto = s->session_type;
108 if (s->flags & VCL_SESSION_F_CONNECTED)
109 mp->flags |= TRANSPORT_CFG_F_CONNECTED;
111 vcl_msg_add_ext_config (s, &mp->ext_config);
112 app_send_ctrl_evt_to_vpp (mq, app_evt);
116 clib_mem_free (s->ext_config);
122 vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s)
124 app_session_evt_t _app_evt, *app_evt = &_app_evt;
125 session_unlisten_msg_t *mp;
128 mq = vcl_worker_ctrl_mq (wrk);
129 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_UNLISTEN);
130 mp = (session_unlisten_msg_t *) app_evt->evt->data;
131 memset (mp, 0, sizeof (*mp));
132 mp->client_index = wrk->api_client_handle;
133 mp->wrk_index = wrk->vpp_wrk_index;
134 mp->handle = s->vpp_handle;
135 mp->context = wrk->wrk_index;
136 app_send_ctrl_evt_to_vpp (mq, app_evt);
140 vcl_send_session_shutdown (vcl_worker_t *wrk, vcl_session_t *s)
142 app_session_evt_t _app_evt, *app_evt = &_app_evt;
143 session_shutdown_msg_t *mp;
146 /* Send to thread that owns the session */
148 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_SHUTDOWN);
149 mp = (session_shutdown_msg_t *) app_evt->evt->data;
150 memset (mp, 0, sizeof (*mp));
151 mp->client_index = wrk->api_client_handle;
152 mp->handle = s->vpp_handle;
153 app_send_ctrl_evt_to_vpp (mq, app_evt);
157 vcl_send_session_disconnect (vcl_worker_t * wrk, vcl_session_t * s)
159 app_session_evt_t _app_evt, *app_evt = &_app_evt;
160 session_disconnect_msg_t *mp;
163 /* Send to thread that owns the session */
165 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_DISCONNECT);
166 mp = (session_disconnect_msg_t *) app_evt->evt->data;
167 memset (mp, 0, sizeof (*mp));
168 mp->client_index = wrk->api_client_handle;
169 mp->handle = s->vpp_handle;
170 app_send_ctrl_evt_to_vpp (mq, app_evt);
174 vcl_send_app_detach (vcl_worker_t * wrk)
176 app_session_evt_t _app_evt, *app_evt = &_app_evt;
177 session_app_detach_msg_t *mp;
180 mq = vcl_worker_ctrl_mq (wrk);
181 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_DETACH);
182 mp = (session_app_detach_msg_t *) app_evt->evt->data;
183 memset (mp, 0, sizeof (*mp));
184 mp->client_index = wrk->api_client_handle;
185 app_send_ctrl_evt_to_vpp (mq, app_evt);
189 vcl_send_session_accepted_reply (svm_msg_q_t * mq, u32 context,
190 session_handle_t handle, int retval)
192 app_session_evt_t _app_evt, *app_evt = &_app_evt;
193 session_accepted_reply_msg_t *rmp;
194 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_ACCEPTED_REPLY);
195 rmp = (session_accepted_reply_msg_t *) app_evt->evt->data;
196 rmp->handle = handle;
197 rmp->context = context;
198 rmp->retval = retval;
199 app_send_ctrl_evt_to_vpp (mq, app_evt);
203 vcl_send_session_disconnected_reply (vcl_worker_t * wrk, vcl_session_t * s,
206 app_session_evt_t _app_evt, *app_evt = &_app_evt;
207 session_disconnected_reply_msg_t *rmp;
208 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
209 SESSION_CTRL_EVT_DISCONNECTED_REPLY);
210 rmp = (session_disconnected_reply_msg_t *) app_evt->evt->data;
211 rmp->handle = s->vpp_handle;
212 rmp->context = wrk->api_client_handle;
213 rmp->retval = retval;
214 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
218 vcl_send_session_reset_reply (vcl_worker_t * wrk, vcl_session_t * s,
221 app_session_evt_t _app_evt, *app_evt = &_app_evt;
222 session_reset_reply_msg_t *rmp;
223 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
224 SESSION_CTRL_EVT_RESET_REPLY);
225 rmp = (session_reset_reply_msg_t *) app_evt->evt->data;
226 rmp->handle = s->vpp_handle;
227 rmp->context = wrk->api_client_handle;
228 rmp->retval = retval;
229 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
233 vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
236 app_session_evt_t _app_evt, *app_evt = &_app_evt;
237 session_worker_update_msg_t *mp;
239 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
240 SESSION_CTRL_EVT_WORKER_UPDATE);
241 mp = (session_worker_update_msg_t *) app_evt->evt->data;
242 mp->client_index = wrk->api_client_handle;
243 mp->handle = s->vpp_handle;
244 mp->req_wrk_index = wrk->vpp_wrk_index;
245 mp->wrk_index = wrk_index;
246 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
250 vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len)
252 app_session_evt_t _app_evt, *app_evt = &_app_evt;
253 session_app_wrk_rpc_msg_t *mp;
254 vcl_worker_t *dst_wrk, *wrk;
258 if (data_len > sizeof (mp->data))
261 clib_spinlock_lock (&vcm->workers_lock);
263 dst_wrk = vcl_worker_get_if_valid (dst_wrk_index);
267 wrk = vcl_worker_get_current ();
268 mq = vcl_worker_ctrl_mq (wrk);
269 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_WRK_RPC);
270 mp = (session_app_wrk_rpc_msg_t *) app_evt->evt->data;
271 mp->client_index = wrk->api_client_handle;
272 mp->wrk_index = dst_wrk->vpp_wrk_index;
273 clib_memcpy (mp->data, data, data_len);
274 app_send_ctrl_evt_to_vpp (mq, app_evt);
278 clib_spinlock_unlock (&vcm->workers_lock);
283 vcl_session_transport_attr (vcl_worker_t *wrk, vcl_session_t *s, u8 is_get,
284 transport_endpt_attr_t *attr)
286 app_session_evt_t _app_evt, *app_evt = &_app_evt;
287 session_transport_attr_msg_t *mp;
291 ASSERT (!wrk->session_attr_op);
292 wrk->session_attr_op = 1;
293 wrk->session_attr_op_rv = -1;
296 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_TRANSPORT_ATTR);
297 mp = (session_transport_attr_msg_t *) app_evt->evt->data;
298 memset (mp, 0, sizeof (*mp));
299 mp->client_index = wrk->api_client_handle;
300 mp->handle = s->vpp_handle;
303 app_send_ctrl_evt_to_vpp (mq, app_evt);
305 timeout = clib_time_now (&wrk->clib_time) + 1;
307 while (wrk->session_attr_op && clib_time_now (&wrk->clib_time) < timeout)
308 vcl_flush_mq_events ();
310 if (!wrk->session_attr_op_rv && is_get)
311 *attr = wrk->session_attr_rv;
313 wrk->session_attr_op = 0;
315 return wrk->session_attr_op_rv;
319 vcl_session_accepted_handler (vcl_worker_t * wrk, session_accepted_msg_t * mp,
322 vcl_session_t *session, *listen_session;
325 session = vcl_session_alloc (wrk);
327 listen_session = vcl_session_get (wrk, ls_index);
328 if (listen_session->vpp_handle != mp->listener_handle)
330 VDBG (0, "ERROR: listener handle %lu does not match session %u",
331 mp->listener_handle, ls_index);
335 if (vcl_segment_attach_session (
336 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
337 mp->vpp_event_queue_address, mp->mq_index, 0, session))
339 VDBG (0, "failed to attach fifos for %u", session->session_index);
343 session->vpp_handle = mp->handle;
344 session->session_state = VCL_STATE_READY;
345 session->transport.rmt_port = mp->rmt.port;
346 session->transport.is_ip4 = mp->rmt.is_ip4;
347 clib_memcpy_fast (&session->transport.rmt_ip, &mp->rmt.ip,
348 sizeof (ip46_address_t));
350 vcl_session_table_add_vpp_handle (wrk, mp->handle, session->session_index);
351 session->transport.lcl_port = mp->lcl.port;
352 session->transport.lcl_ip = mp->lcl.ip;
353 session->session_type = listen_session->session_type;
354 session->is_dgram = vcl_proto_is_dgram (session->session_type);
355 session->listener_index = listen_session->session_index;
356 listen_session->n_accepted_sessions++;
359 "session %u [0x%llx]: client accept request from %s address %U"
360 " port %d queue %p!",
361 session->session_index, mp->handle, mp->rmt.is_ip4 ? "IPv4" : "IPv6",
362 vcl_format_ip46_address, &mp->rmt.ip,
363 mp->rmt.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
364 clib_net_to_host_u16 (mp->rmt.port), session->vpp_evt_q);
365 vcl_evt (VCL_EVT_ACCEPT, session, listen_session, session_index);
367 vcl_send_session_accepted_reply (session->vpp_evt_q, mp->context,
368 session->vpp_handle, 0);
370 return session->session_index;
373 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0),
374 mp->vpp_event_queue_address, mp->mq_index, &evt_q);
375 vcl_send_session_accepted_reply (evt_q, mp->context, mp->handle,
376 VNET_API_ERROR_INVALID_ARGUMENT);
377 vcl_session_free (wrk, session);
378 return VCL_INVALID_SESSION_INDEX;
382 vcl_session_connected_handler (vcl_worker_t * wrk,
383 session_connected_msg_t * mp)
385 vcl_session_t *session = 0;
388 session_index = mp->context;
389 session = vcl_session_get (wrk, session_index);
390 if (PREDICT_FALSE (!session))
392 VERR ("vpp handle 0x%llx has no session index (%u)!", mp->handle,
394 /* Should not happen but if it does, force vpp session cleanup */
395 vcl_session_t tmp_session = {
396 .vpp_handle = mp->handle,
399 vcl_segment_attach_session (
400 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
401 mp->vpp_event_queue_address, mp->mq_index, 0, session);
402 if (tmp_session.vpp_evt_q)
403 vcl_send_session_disconnect (wrk, &tmp_session);
404 return VCL_INVALID_SESSION_INDEX;
409 VDBG (0, "session index %u: connect failed! %U", session_index,
410 format_session_error, mp->retval);
411 session->session_state = VCL_STATE_DETACHED;
412 session->vpp_handle = VCL_INVALID_SESSION_HANDLE;
413 return session_index;
416 session->vpp_handle = mp->handle;
418 /* Add to lookup table. Even if something fails, session cannot be
419 * cleaned up prior to notifying vpp and going through the cleanup
420 * "procedure" see @ref vcl_session_cleanup_handler */
421 vcl_session_table_add_vpp_handle (wrk, mp->handle, session_index);
423 if (vcl_segment_attach_session (
424 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
425 mp->vpp_event_queue_address, mp->mq_index, 0, session))
427 VDBG (0, "failed to attach fifos for %u", session->session_index);
428 session->session_state = VCL_STATE_UPDATED;
429 vcl_send_session_disconnect (wrk, session);
430 return session_index;
435 if (vcl_segment_attach_session (mp->ct_segment_handle, mp->ct_rx_fifo,
436 mp->ct_tx_fifo, (uword) ~0, ~0, 1,
439 VDBG (0, "failed to attach ct fifos for %u", session->session_index);
440 session->session_state = VCL_STATE_UPDATED;
441 vcl_send_session_disconnect (wrk, session);
442 return session_index;
446 session->transport.is_ip4 = mp->lcl.is_ip4;
447 clib_memcpy_fast (&session->transport.lcl_ip, &mp->lcl.ip,
448 sizeof (session->transport.lcl_ip));
449 session->transport.lcl_port = mp->lcl.port;
451 /* Application closed session before connect reply */
452 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK)
453 && session->session_state == VCL_STATE_CLOSED)
454 vcl_send_session_disconnect (wrk, session);
456 session->session_state = VCL_STATE_READY;
458 VDBG (1, "session %u [0x%llx] connected! rx_fifo %p, refcnt %d, tx_fifo %p,"
459 " refcnt %d", session_index, mp->handle, session->rx_fifo,
460 session->rx_fifo->refcnt, session->tx_fifo, session->tx_fifo->refcnt);
462 return session_index;
466 vcl_flag_accepted_session (vcl_session_t * session, u64 handle, u32 flags)
468 vcl_session_msg_t *accepted_msg;
471 for (i = 0; i < vec_len (session->accept_evts_fifo); i++)
473 accepted_msg = &session->accept_evts_fifo[i];
474 if (accepted_msg->accepted_msg.handle == handle)
476 accepted_msg->flags |= flags;
484 vcl_session_reset_handler (vcl_worker_t * wrk,
485 session_reset_msg_t * reset_msg)
487 vcl_session_t *session;
490 sid = vcl_session_index_from_vpp_handle (wrk, reset_msg->handle);
491 session = vcl_session_get (wrk, sid);
494 VDBG (0, "request to reset unknown handle 0x%llx", reset_msg->handle);
495 return VCL_INVALID_SESSION_INDEX;
498 /* Caught a reset before actually accepting the session */
499 if (session->session_state == VCL_STATE_LISTEN)
502 if (!vcl_flag_accepted_session (session, reset_msg->handle,
503 VCL_ACCEPTED_F_RESET))
504 VDBG (0, "session was not accepted!");
505 return VCL_INVALID_SESSION_INDEX;
508 if (session->session_state != VCL_STATE_CLOSED)
509 session->session_state = VCL_STATE_DISCONNECT;
510 VDBG (0, "reset session %u [0x%llx]", sid, reset_msg->handle);
515 vcl_session_bound_handler (vcl_worker_t * wrk, session_bound_msg_t * mp)
517 vcl_session_t *session;
518 u32 sid = mp->context;
520 session = vcl_session_get (wrk, sid);
523 VERR ("session %u [0x%llx]: bind failed: %U", sid, mp->handle,
524 format_session_error, mp->retval);
527 session->session_state = VCL_STATE_DETACHED;
528 session->vpp_handle = mp->handle;
533 VDBG (0, "ERROR: session %u [0x%llx]: Invalid session index!",
535 return VCL_INVALID_SESSION_INDEX;
539 session->vpp_handle = mp->handle;
540 session->transport.is_ip4 = mp->lcl_is_ip4;
541 clib_memcpy_fast (&session->transport.lcl_ip, mp->lcl_ip,
542 sizeof (ip46_address_t));
543 session->transport.lcl_port = mp->lcl_port;
544 vcl_session_table_add_listener (wrk, mp->handle, sid);
545 session->session_state = VCL_STATE_LISTEN;
547 if (vcl_session_is_cl (session))
549 if (vcl_segment_attach_session (mp->segment_handle, mp->rx_fifo,
550 mp->tx_fifo, mp->vpp_evt_q, mp->mq_index,
553 VDBG (0, "failed to attach fifos for %u", session->session_index);
554 session->session_state = VCL_STATE_DETACHED;
555 return VCL_INVALID_SESSION_INDEX;
559 VDBG (0, "session %u [0x%llx]: listen succeeded!", sid, mp->handle);
564 vcl_session_unlisten_reply_handler (vcl_worker_t * wrk, void *data)
566 session_unlisten_reply_msg_t *mp = (session_unlisten_reply_msg_t *) data;
569 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
572 VDBG (0, "Unlisten reply with wrong handle %llx", mp->handle);
575 if (s->session_state != VCL_STATE_DISCONNECT)
577 /* Connected udp listener */
578 if (s->session_type == VPPCOM_PROTO_UDP
579 && s->session_state == VCL_STATE_CLOSED)
582 VDBG (0, "Unlisten session in wrong state %llx", mp->handle);
587 VDBG (0, "ERROR: session %u [0xllx]: unlisten failed: %U",
588 s->session_index, mp->handle, format_session_error, mp->retval);
590 if (mp->context != wrk->wrk_index)
591 VDBG (0, "wrong context");
593 vcl_session_table_del_vpp_handle (wrk, mp->handle);
594 vcl_session_free (wrk, s);
598 vcl_session_migrated_handler (vcl_worker_t * wrk, void *data)
600 session_migrated_msg_t *mp = (session_migrated_msg_t *) data;
604 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
607 VDBG (0, "Migrated notification with wrong handle %llx", mp->handle);
611 /* Only validate if a value is provided */
612 if (mp->segment_handle != SESSION_INVALID_HANDLE)
614 fs_index = vcl_segment_table_lookup (mp->segment_handle);
615 if (fs_index == VCL_INVALID_SEGMENT_INDEX)
617 VDBG (0, "segment %lx for session %u is not mounted!",
618 mp->segment_handle, s->session_index);
619 s->session_state = VCL_STATE_DETACHED;
624 s->vpp_handle = mp->new_handle;
626 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0), mp->vpp_evt_q,
627 mp->vpp_thread_index, &s->vpp_evt_q);
629 vcl_session_table_del_vpp_handle (wrk, mp->handle);
630 vcl_session_table_add_vpp_handle (wrk, mp->new_handle, s->session_index);
632 /* Generate new tx event if we have outstanding data */
633 if (svm_fifo_has_event (s->tx_fifo))
634 app_send_io_evt_to_vpp (s->vpp_evt_q,
635 s->tx_fifo->shr->master_session_index,
636 SESSION_IO_EVT_TX, SVM_Q_WAIT);
638 VDBG (0, "Migrated 0x%lx to thread %u 0x%lx", mp->handle,
639 mp->vpp_thread_index, mp->new_handle);
642 static vcl_session_t *
643 vcl_session_accepted (vcl_worker_t * wrk, session_accepted_msg_t * msg)
645 vcl_session_msg_t *vcl_msg;
646 vcl_session_t *session;
648 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
649 if (PREDICT_FALSE (session != 0))
650 VWRN ("session overlap handle %lu state %u!", msg->handle,
651 session->session_state);
653 session = vcl_session_table_lookup_listener (wrk, msg->listener_handle);
656 VERR ("couldn't find listen session: listener handle %llx",
657 msg->listener_handle);
661 clib_fifo_add2 (session->accept_evts_fifo, vcl_msg);
663 vcl_msg->accepted_msg = *msg;
664 /* Session handle points to listener until fully accepted by app */
665 vcl_session_table_add_vpp_handle (wrk, msg->handle, session->session_index);
670 static vcl_session_t *
671 vcl_session_disconnected_handler (vcl_worker_t * wrk,
672 session_disconnected_msg_t * msg)
674 vcl_session_t *session;
676 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
679 VDBG (0, "request to disconnect unknown handle 0x%llx", msg->handle);
683 /* Late disconnect notification on a session that has been closed */
684 if (session->session_state == VCL_STATE_CLOSED)
687 /* Caught a disconnect before actually accepting the session */
688 if (session->session_state == VCL_STATE_LISTEN)
690 if (!vcl_flag_accepted_session (session, msg->handle,
691 VCL_ACCEPTED_F_CLOSED))
692 VDBG (0, "session was not accepted!");
696 /* If not already reset change state */
697 if (session->session_state != VCL_STATE_DISCONNECT)
698 session->session_state = VCL_STATE_VPP_CLOSING;
704 vppcom_session_shutdown (uint32_t session_handle, int how)
706 vcl_worker_t *wrk = vcl_worker_get_current ();
707 vcl_session_t *session;
708 vcl_session_state_t state;
711 session = vcl_session_get_w_handle (wrk, session_handle);
712 if (PREDICT_FALSE (!session))
713 return VPPCOM_EBADFD;
715 vpp_handle = session->vpp_handle;
716 state = session->session_state;
718 VDBG (1, "session %u [0x%llx] state 0x%x (%s)", session->session_index,
719 vpp_handle, state, vcl_session_state_str (state));
721 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
723 VDBG (0, "ERROR: Cannot shutdown a listen socket!");
724 return VPPCOM_EBADFD;
727 if (how == SHUT_RD || how == SHUT_RDWR)
729 session->flags |= VCL_SESSION_F_RD_SHUTDOWN;
733 session->flags |= VCL_SESSION_F_WR_SHUTDOWN;
735 if (PREDICT_TRUE (state == VCL_STATE_READY))
737 VDBG (1, "session %u [0x%llx]: sending shutdown...",
738 session->session_index, vpp_handle);
740 vcl_send_session_shutdown (wrk, session);
747 vppcom_session_disconnect (u32 session_handle)
749 vcl_worker_t *wrk = vcl_worker_get_current ();
750 vcl_session_t *session, *listen_session;
751 vcl_session_state_t state;
754 session = vcl_session_get_w_handle (wrk, session_handle);
756 return VPPCOM_EBADFD;
758 vpp_handle = session->vpp_handle;
759 state = session->session_state;
761 VDBG (1, "session %u [0x%llx] state 0x%x (%s)", session->session_index,
762 vpp_handle, state, vcl_session_state_str (state));
764 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
766 VDBG (0, "ERROR: Cannot disconnect a listen socket!");
767 return VPPCOM_EBADFD;
770 if (state == VCL_STATE_VPP_CLOSING)
772 vcl_send_session_disconnected_reply (wrk, session, 0);
773 VDBG (1, "session %u [0x%llx]: sending disconnect REPLY...",
774 session->session_index, vpp_handle);
778 /* Session doesn't have an event queue yet. Probably a non-blocking
779 * connect. Wait for the reply */
780 if (PREDICT_FALSE (!session->vpp_evt_q))
783 VDBG (1, "session %u [0x%llx]: sending disconnect...",
784 session->session_index, vpp_handle);
785 vcl_send_session_disconnect (wrk, session);
788 if (session->listener_index != VCL_INVALID_SESSION_INDEX)
790 listen_session = vcl_session_get (wrk, session->listener_index);
791 listen_session->n_accepted_sessions--;
798 vcl_session_cleanup_handler (vcl_worker_t * wrk, void *data)
800 session_cleanup_msg_t *msg;
801 vcl_session_t *session;
803 msg = (session_cleanup_msg_t *) data;
804 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
807 VDBG (0, "disconnect confirmed for unknown handle 0x%llx", msg->handle);
811 if (msg->type == SESSION_CLEANUP_TRANSPORT)
813 /* Transport was cleaned up before we confirmed close. Probably the
814 * app is still waiting for some data that cannot be delivered.
815 * Confirm close to make sure everything is cleaned up.
816 * Move to undetermined state to ensure that the session is not
817 * removed before both vpp and the app cleanup.
818 * - If the app closes first, the session is moved to CLOSED state
819 * and the session cleanup notification from vpp removes the
821 * - If vpp cleans up the session first, the session is moved to
822 * DETACHED state lower and subsequently the close from the app
825 if (session->session_state == VCL_STATE_VPP_CLOSING)
827 vppcom_session_disconnect (vcl_session_handle (session));
828 session->session_state = VCL_STATE_UPDATED;
830 else if (session->session_state == VCL_STATE_DISCONNECT)
832 vcl_send_session_reset_reply (wrk, session, 0);
833 session->session_state = VCL_STATE_UPDATED;
838 /* VPP will reuse the handle so clean it up now */
839 vcl_session_table_del_vpp_handle (wrk, msg->handle);
841 /* App did not close the connection yet so don't free it. */
842 if (session->session_state != VCL_STATE_CLOSED)
844 VDBG (0, "app did not close session %d", session->session_index);
845 session->session_state = VCL_STATE_DETACHED;
846 session->vpp_handle = VCL_INVALID_SESSION_HANDLE;
850 /* Session probably tracked with epoll, disconnect not yet handled and
851 * 1) both transport and session cleanup completed 2) app closed. Wait
852 * until message is drained to free the session.
853 * See @ref vcl_handle_mq_event */
854 if (session->flags & VCL_SESSION_F_PENDING_DISCONNECT)
856 session->flags |= VCL_SESSION_F_PENDING_FREE;
860 vcl_session_free (wrk, session);
864 vcl_session_req_worker_update_handler (vcl_worker_t * wrk, void *data)
866 session_req_worker_update_msg_t *msg;
869 msg = (session_req_worker_update_msg_t *) data;
870 s = vcl_session_get_w_vpp_handle (wrk, msg->session_handle);
874 vec_add1 (wrk->pending_session_wrk_updates, s->session_index);
878 vcl_session_worker_update_reply_handler (vcl_worker_t * wrk, void *data)
880 session_worker_update_reply_msg_t *msg;
883 msg = (session_worker_update_reply_msg_t *) data;
884 s = vcl_session_get_w_vpp_handle (wrk, msg->handle);
887 VDBG (0, "unknown handle 0x%llx", msg->handle);
893 if (vcl_segment_attach_session (msg->segment_handle, msg->rx_fifo,
894 msg->tx_fifo, (uword) ~0, ~0, 0, s))
896 VDBG (0, "failed to attach fifos for %u", s->session_index);
900 s->session_state = VCL_STATE_UPDATED;
902 VDBG (0, "session %u[0x%llx] moved to worker %u", s->session_index,
903 s->vpp_handle, wrk->wrk_index);
907 vcl_api_recv_fd (vcl_worker_t * wrk, int *fds, int n_fds)
910 if (vcm->cfg.vpp_app_socket_api)
911 return vcl_sapi_recv_fds (wrk, fds, n_fds);
913 return vcl_bapi_recv_fds (wrk, fds, n_fds);
917 vcl_session_app_add_segment_handler (vcl_worker_t * wrk, void *data)
919 ssvm_segment_type_t seg_type = SSVM_SEGMENT_SHM;
920 session_app_add_segment_msg_t *msg;
924 msg = (session_app_add_segment_msg_t *) data;
928 vcl_api_recv_fd (wrk, &fd, 1);
929 seg_type = SSVM_SEGMENT_MEMFD;
932 segment_handle = msg->segment_handle;
933 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
935 clib_warning ("invalid segment handle");
939 if (vcl_segment_attach (segment_handle, (char *) msg->segment_name,
942 VDBG (0, "vcl_segment_attach ('%s') failed", msg->segment_name);
946 VDBG (1, "mapped new segment '%s' size %d", msg->segment_name,
951 vcl_session_app_del_segment_handler (vcl_worker_t * wrk, void *data)
953 session_app_del_segment_msg_t *msg = (session_app_del_segment_msg_t *) data;
954 vcl_segment_detach (msg->segment_handle);
955 VDBG (1, "Unmapped segment: %d", msg->segment_handle);
959 vcl_worker_rpc_handler (vcl_worker_t * wrk, void *data)
961 if (!vcm->wrk_rpc_fn)
964 (vcm->wrk_rpc_fn) (((session_app_wrk_rpc_msg_t *) data)->data);
968 vcl_session_transport_attr_reply_handler (vcl_worker_t *wrk, void *data)
970 session_transport_attr_reply_msg_t *mp;
972 if (!wrk->session_attr_op)
975 mp = (session_transport_attr_reply_msg_t *) data;
977 wrk->session_attr_op_rv = mp->retval;
978 wrk->session_attr_op = 0;
979 wrk->session_attr_rv = mp->attr;
983 vcl_handle_mq_event (vcl_worker_t * wrk, session_event_t * e)
985 session_disconnected_msg_t *disconnected_msg;
986 session_connected_msg_t *connected_msg;
987 session_reset_msg_t *reset_msg;
988 session_event_t *ecpy;
992 switch (e->event_type)
994 case SESSION_IO_EVT_RX:
995 case SESSION_IO_EVT_TX:
996 s = vcl_session_get (wrk, e->session_index);
997 if (!s || !vcl_session_is_open (s))
999 vec_add1 (wrk->unhandled_evts_vector, *e);
1001 case SESSION_CTRL_EVT_BOUND:
1002 /* We can only wait for only one listen so not postponed */
1003 vcl_session_bound_handler (wrk, (session_bound_msg_t *) e->data);
1005 case SESSION_CTRL_EVT_ACCEPTED:
1006 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
1007 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1009 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1011 ecpy->postponed = 1;
1012 ecpy->session_index = s->session_index;
1015 case SESSION_CTRL_EVT_CONNECTED:
1016 connected_msg = (session_connected_msg_t *) e->data;
1017 sid = vcl_session_connected_handler (wrk, connected_msg);
1018 if (!(s = vcl_session_get (wrk, sid)))
1020 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1022 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1024 ecpy->postponed = 1;
1025 ecpy->session_index = s->session_index;
1028 case SESSION_CTRL_EVT_DISCONNECTED:
1029 disconnected_msg = (session_disconnected_msg_t *) e->data;
1030 if (!(s = vcl_session_get_w_vpp_handle (wrk, disconnected_msg->handle)))
1032 if (s->session_state == VCL_STATE_CLOSED)
1034 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1036 s->session_state = VCL_STATE_VPP_CLOSING;
1037 s->flags |= VCL_SESSION_F_PENDING_DISCONNECT;
1038 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1040 ecpy->postponed = 1;
1041 ecpy->session_index = s->session_index;
1044 if (!(s = vcl_session_disconnected_handler (wrk, disconnected_msg)))
1046 VDBG (0, "disconnected session %u [0x%llx]", s->session_index,
1049 case SESSION_CTRL_EVT_RESET:
1050 reset_msg = (session_reset_msg_t *) e->data;
1051 if (!(s = vcl_session_get_w_vpp_handle (wrk, reset_msg->handle)))
1053 if (s->session_state == VCL_STATE_CLOSED)
1055 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1057 s->flags |= VCL_SESSION_F_PENDING_DISCONNECT;
1058 s->session_state = VCL_STATE_DISCONNECT;
1059 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1061 ecpy->postponed = 1;
1062 ecpy->session_index = s->session_index;
1065 vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
1067 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
1068 vcl_session_unlisten_reply_handler (wrk, e->data);
1070 case SESSION_CTRL_EVT_MIGRATED:
1071 vcl_session_migrated_handler (wrk, e->data);
1073 case SESSION_CTRL_EVT_CLEANUP:
1074 vcl_session_cleanup_handler (wrk, e->data);
1076 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
1077 vcl_session_req_worker_update_handler (wrk, e->data);
1079 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
1080 vcl_session_worker_update_reply_handler (wrk, e->data);
1082 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
1083 vcl_session_app_add_segment_handler (wrk, e->data);
1085 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
1086 vcl_session_app_del_segment_handler (wrk, e->data);
1088 case SESSION_CTRL_EVT_APP_WRK_RPC:
1089 vcl_worker_rpc_handler (wrk, e->data);
1091 case SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY:
1092 vcl_session_transport_attr_reply_handler (wrk, e->data);
1095 clib_warning ("unhandled %u", e->event_type);
1101 vppcom_wait_for_session_state_change (u32 session_index,
1102 vcl_session_state_t state,
1105 vcl_worker_t *wrk = vcl_worker_get_current ();
1106 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
1107 vcl_session_t *volatile session;
1108 svm_msg_q_msg_t msg;
1113 session = vcl_session_get (wrk, session_index);
1114 if (PREDICT_FALSE (!session))
1116 return VPPCOM_EBADFD;
1118 if (session->session_state == state)
1122 if (session->session_state == VCL_STATE_DETACHED)
1124 return VPPCOM_ECONNREFUSED;
1127 if (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0))
1132 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
1133 vcl_handle_mq_event (wrk, e);
1134 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
1136 while (clib_time_now (&wrk->clib_time) < timeout);
1138 VDBG (0, "timeout waiting for state 0x%x (%s)", state,
1139 vcl_session_state_str (state));
1140 vcl_evt (VCL_EVT_SESSION_TIMEOUT, session, session_state);
1142 return VPPCOM_ETIMEDOUT;
1146 vcl_handle_pending_wrk_updates (vcl_worker_t * wrk)
1148 vcl_session_state_t state;
1152 if (PREDICT_TRUE (vec_len (wrk->pending_session_wrk_updates) == 0))
1155 vec_foreach (sip, wrk->pending_session_wrk_updates)
1157 s = vcl_session_get (wrk, *sip);
1158 vcl_send_session_worker_update (wrk, s, wrk->wrk_index);
1159 state = s->session_state;
1160 vppcom_wait_for_session_state_change (s->session_index, VCL_STATE_UPDATED,
1162 s->session_state = state;
1164 vec_reset_length (wrk->pending_session_wrk_updates);
1168 vcl_worker_flush_mq_events (vcl_worker_t *wrk)
1170 svm_msg_q_msg_t *msg;
1175 mq = wrk->app_event_queue;
1176 vcl_mq_dequeue_batch (wrk, mq, ~0);
1178 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
1180 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
1181 e = svm_msg_q_msg_data (mq, msg);
1182 vcl_handle_mq_event (wrk, e);
1183 svm_msg_q_free_msg (mq, msg);
1185 vec_reset_length (wrk->mq_msg_vector);
1186 vcl_handle_pending_wrk_updates (wrk);
1190 vcl_flush_mq_events (void)
1192 vcl_worker_flush_mq_events (vcl_worker_get_current ());
1196 vppcom_session_unbind (u32 session_handle)
1198 vcl_worker_t *wrk = vcl_worker_get_current ();
1199 session_accepted_msg_t *accepted_msg;
1200 vcl_session_t *session = 0;
1201 vcl_session_msg_t *evt;
1203 session = vcl_session_get_w_handle (wrk, session_handle);
1205 return VPPCOM_EBADFD;
1207 /* Flush pending accept events, if any */
1208 while (clib_fifo_elts (session->accept_evts_fifo))
1210 clib_fifo_sub2 (session->accept_evts_fifo, evt);
1211 accepted_msg = &evt->accepted_msg;
1212 vcl_session_table_del_vpp_handle (wrk, accepted_msg->handle);
1213 vcl_send_session_accepted_reply (session->vpp_evt_q,
1214 accepted_msg->context,
1215 accepted_msg->handle, -1);
1217 clib_fifo_free (session->accept_evts_fifo);
1219 vcl_send_session_unlisten (wrk, session);
1221 VDBG (1, "session %u [0x%llx]: sending unbind!", session->session_index,
1222 session->vpp_handle);
1223 vcl_evt (VCL_EVT_UNBIND, session);
1225 session->vpp_handle = ~0;
1226 session->session_state = VCL_STATE_DISCONNECT;
1234 * Notify vpp of the disconnect and mark the worker as free. If we're the
1235 * last worker, do a full cleanup otherwise, since we're probably a forked
1236 * child, avoid syscalls as much as possible. We might've lost privileges.
1239 vppcom_app_exit (void)
1241 if (!pool_elts (vcm->workers))
1243 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
1244 vcl_set_worker_index (~0);
1245 vcl_elog_stop (vcm);
1249 vcl_api_attach (void)
1251 if (vcm->cfg.vpp_app_socket_api)
1252 return vcl_sapi_attach ();
1254 return vcl_bapi_attach ();
1258 vcl_api_detach (vcl_worker_t * wrk)
1260 vcl_send_app_detach (wrk);
1262 if (vcm->cfg.vpp_app_socket_api)
1263 return vcl_sapi_detach (wrk);
1265 return vcl_bapi_disconnect_from_vpp ();
1269 * VPPCOM Public API functions
1272 vppcom_app_create (const char *app_name)
1274 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1279 VDBG (1, "already initialized");
1280 return VPPCOM_EEXIST;
1284 vppcom_cfg (&vcm->cfg);
1285 vcl_cfg = &vcm->cfg;
1287 vcm->main_cpu = pthread_self ();
1288 vcm->main_pid = getpid ();
1289 vcm->app_name = format (0, "%s", app_name);
1290 fifo_segment_main_init (&vcm->segment_main, (uword) ~0,
1291 20 /* timeout in secs */);
1292 pool_alloc (vcm->workers, vcl_cfg->max_workers);
1293 clib_spinlock_init (&vcm->workers_lock);
1294 clib_rwlock_init (&vcm->segment_table_lock);
1295 atexit (vppcom_app_exit);
1296 vcl_elog_init (vcm);
1298 /* Allocate default worker */
1299 vcl_worker_alloc_and_init ();
1301 if ((rv = vcl_api_attach ()))
1304 VDBG (0, "app_name '%s', my_client_index %d (0x%x)", app_name,
1305 vcm->workers[0].api_client_handle, vcm->workers[0].api_client_handle);
1311 vppcom_app_destroy (void)
1313 vcl_worker_t *wrk, *current_wrk;
1316 if (!pool_elts (vcm->workers))
1319 vcl_evt (VCL_EVT_DETACH, vcm);
1321 current_wrk = vcl_worker_get_current ();
1324 pool_foreach (wrk, vcm->workers) {
1325 if (current_wrk != wrk)
1326 vcl_worker_cleanup (wrk, 0 /* notify vpp */ );
1330 vcl_api_detach (current_wrk);
1331 vcl_worker_cleanup (current_wrk, 0 /* notify vpp */ );
1333 vcl_elog_stop (vcm);
1336 * Free the heap and fix vcm
1338 heap = clib_mem_get_heap ();
1339 munmap (clib_mem_get_heap_base (heap), clib_mem_get_heap_size (heap));
1341 vcm = &_vppcom_main;
1346 vppcom_session_create (u8 proto, u8 is_nonblocking)
1348 vcl_worker_t *wrk = vcl_worker_get_current ();
1349 vcl_session_t *session;
1351 session = vcl_session_alloc (wrk);
1353 session->session_type = proto;
1354 session->session_state = VCL_STATE_CLOSED;
1355 session->vpp_handle = ~0;
1356 session->is_dgram = vcl_proto_is_dgram (proto);
1359 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
1361 vcl_evt (VCL_EVT_CREATE, session, session_type, session->session_state,
1362 is_nonblocking, session_index);
1364 VDBG (0, "created session %u", session->session_index);
1366 return vcl_session_handle (session);
1370 vcl_epoll_lt_add (vcl_worker_t *wrk, vcl_session_t *s)
1372 vcl_session_t *cur, *prev;
1374 if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX)
1376 wrk->ep_lt_current = s->session_index;
1377 s->vep.lt_next = s->session_index;
1378 s->vep.lt_prev = s->session_index;
1382 cur = vcl_session_get (wrk, wrk->ep_lt_current);
1383 prev = vcl_session_get (wrk, cur->vep.lt_prev);
1385 prev->vep.lt_next = s->session_index;
1386 s->vep.lt_prev = prev->session_index;
1388 s->vep.lt_next = cur->session_index;
1389 cur->vep.lt_prev = s->session_index;
1393 vcl_epoll_lt_del (vcl_worker_t *wrk, vcl_session_t *s)
1395 vcl_session_t *prev, *next;
1397 if (s->vep.lt_next == s->session_index)
1399 wrk->ep_lt_current = VCL_INVALID_SESSION_INDEX;
1400 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
1404 prev = vcl_session_get (wrk, s->vep.lt_prev);
1405 next = vcl_session_get (wrk, s->vep.lt_next);
1407 prev->vep.lt_next = next->session_index;
1408 next->vep.lt_prev = prev->session_index;
1410 if (s->session_index == wrk->ep_lt_current)
1411 wrk->ep_lt_current = s->vep.lt_next;
1413 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
1417 vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * s,
1418 vcl_session_handle_t sh, u8 do_disconnect)
1422 VDBG (1, "session %u [0x%llx] closing", s->session_index, s->vpp_handle);
1424 if (s->flags & VCL_SESSION_F_IS_VEP)
1426 u32 next_sh = s->vep.next_sh;
1427 while (next_sh != ~0)
1429 rv = vppcom_epoll_ctl (sh, EPOLL_CTL_DEL, next_sh, 0);
1430 if (PREDICT_FALSE (rv < 0))
1431 VDBG (0, "vpp handle 0x%llx, sh %u: EPOLL_CTL_DEL vep_idx %u"
1432 " failed! rv %d (%s)", s->vpp_handle, next_sh,
1433 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1434 next_sh = s->vep.next_sh;
1439 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
1441 rv = vppcom_epoll_ctl (s->vep.vep_sh, EPOLL_CTL_DEL, sh, 0);
1443 VDBG (0, "session %u [0x%llx]: EPOLL_CTL_DEL vep_idx %u "
1444 "failed! rv %d (%s)", s->session_index, s->vpp_handle,
1445 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1450 VDBG (1, "session %u [0x%llx] disconnect skipped",
1451 s->session_index, s->vpp_handle);
1455 if (s->session_state == VCL_STATE_LISTEN)
1457 rv = vppcom_session_unbind (sh);
1458 if (PREDICT_FALSE (rv < 0))
1459 VDBG (0, "session %u [0x%llx]: listener unbind failed! "
1460 "rv %d (%s)", s->session_index, s->vpp_handle, rv,
1461 vppcom_retval_str (rv));
1464 else if (vcl_session_is_ready (s)
1465 || (vcl_session_is_connectable_listener (wrk, s)))
1467 rv = vppcom_session_disconnect (sh);
1468 if (PREDICT_FALSE (rv < 0))
1469 VDBG (0, "ERROR: session %u [0x%llx]: disconnect failed!"
1470 " rv %d (%s)", s->session_index, s->vpp_handle,
1471 rv, vppcom_retval_str (rv));
1473 else if (s->session_state == VCL_STATE_DISCONNECT)
1475 vcl_send_session_reset_reply (wrk, s, 0);
1477 else if (s->session_state == VCL_STATE_DETACHED)
1479 VDBG (0, "vpp freed session %d before close", s->session_index);
1481 if (!(s->flags & VCL_SESSION_F_PENDING_DISCONNECT))
1484 /* Disconnect/reset messages pending but vpp transport and session
1485 * cleanups already done. Free only after messages drained. */
1486 s->flags |= VCL_SESSION_F_PENDING_FREE;
1489 s->session_state = VCL_STATE_CLOSED;
1491 /* Session is removed only after vpp confirms the disconnect */
1495 vcl_session_table_del_vpp_handle (wrk, s->vpp_handle);
1497 vcl_session_free (wrk, s);
1498 vcl_evt (VCL_EVT_CLOSE, s, rv);
1504 vppcom_session_close (uint32_t session_handle)
1506 vcl_worker_t *wrk = vcl_worker_get_current ();
1507 vcl_session_t *session;
1509 session = vcl_session_get_w_handle (wrk, session_handle);
1511 return VPPCOM_EBADFD;
1512 return vcl_session_cleanup (wrk, session, session_handle,
1513 1 /* do_disconnect */ );
1517 vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep)
1519 vcl_worker_t *wrk = vcl_worker_get_current ();
1520 vcl_session_t *session = 0;
1523 return VPPCOM_EINVAL;
1525 session = vcl_session_get_w_handle (wrk, session_handle);
1527 return VPPCOM_EBADFD;
1529 if (session->flags & VCL_SESSION_F_IS_VEP)
1531 VDBG (0, "ERROR: cannot bind to epoll session %u!",
1532 session->session_index);
1533 return VPPCOM_EBADFD;
1536 session->transport.is_ip4 = ep->is_ip4;
1538 clib_memcpy_fast (&session->transport.lcl_ip.ip4, ep->ip,
1539 sizeof (ip4_address_t));
1541 clib_memcpy_fast (&session->transport.lcl_ip.ip6, ep->ip,
1542 sizeof (ip6_address_t));
1543 session->transport.lcl_port = ep->port;
1546 "session %u handle %u: binding to local %s address %U port %u, "
1548 session->session_index, session_handle,
1549 session->transport.is_ip4 ? "IPv4" : "IPv6", vcl_format_ip46_address,
1550 &session->transport.lcl_ip,
1551 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1552 clib_net_to_host_u16 (session->transport.lcl_port),
1553 vppcom_proto_str (session->session_type));
1554 vcl_evt (VCL_EVT_BIND, session);
1556 if (session->session_type == VPPCOM_PROTO_UDP)
1557 vppcom_session_listen (session_handle, 10);
1563 vppcom_session_listen (uint32_t listen_sh, uint32_t q_len)
1565 vcl_worker_t *wrk = vcl_worker_get_current ();
1566 vcl_session_t *listen_session = 0;
1567 u64 listen_vpp_handle;
1570 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1571 if (!listen_session || (listen_session->flags & VCL_SESSION_F_IS_VEP))
1572 return VPPCOM_EBADFD;
1574 listen_vpp_handle = listen_session->vpp_handle;
1575 if (listen_session->session_state == VCL_STATE_LISTEN)
1577 VDBG (0, "session %u [0x%llx]: already in listen state!",
1578 listen_sh, listen_vpp_handle);
1582 VDBG (0, "session %u: sending vpp listen request...", listen_sh);
1585 * Send listen request to vpp and wait for reply
1587 vcl_send_session_listen (wrk, listen_session);
1588 rv = vppcom_wait_for_session_state_change (listen_session->session_index,
1590 vcm->cfg.session_timeout);
1592 if (PREDICT_FALSE (rv))
1594 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1595 VDBG (0, "session %u [0x%llx]: listen failed! returning %d (%s)",
1596 listen_sh, listen_session->vpp_handle, rv,
1597 vppcom_retval_str (rv));
1605 validate_args_session_accept_ (vcl_worker_t * wrk, vcl_session_t * ls)
1607 if (ls->flags & VCL_SESSION_F_IS_VEP)
1609 VDBG (0, "ERROR: cannot accept on epoll session %u!",
1611 return VPPCOM_EBADFD;
1614 if ((ls->session_state != VCL_STATE_LISTEN)
1615 && (!vcl_session_is_connectable_listener (wrk, ls)))
1618 "ERROR: session [0x%llx]: not in listen state! state 0x%x"
1620 ls->vpp_handle, ls->session_state,
1621 vcl_session_state_str (ls->session_state));
1622 return VPPCOM_EBADFD;
1628 vppcom_unformat_proto (uint8_t * proto, char *proto_str)
1630 if (!strcmp (proto_str, "TCP"))
1631 *proto = VPPCOM_PROTO_TCP;
1632 else if (!strcmp (proto_str, "tcp"))
1633 *proto = VPPCOM_PROTO_TCP;
1634 else if (!strcmp (proto_str, "UDP"))
1635 *proto = VPPCOM_PROTO_UDP;
1636 else if (!strcmp (proto_str, "udp"))
1637 *proto = VPPCOM_PROTO_UDP;
1638 else if (!strcmp (proto_str, "TLS"))
1639 *proto = VPPCOM_PROTO_TLS;
1640 else if (!strcmp (proto_str, "tls"))
1641 *proto = VPPCOM_PROTO_TLS;
1642 else if (!strcmp (proto_str, "QUIC"))
1643 *proto = VPPCOM_PROTO_QUIC;
1644 else if (!strcmp (proto_str, "quic"))
1645 *proto = VPPCOM_PROTO_QUIC;
1646 else if (!strcmp (proto_str, "DTLS"))
1647 *proto = VPPCOM_PROTO_DTLS;
1648 else if (!strcmp (proto_str, "dtls"))
1649 *proto = VPPCOM_PROTO_DTLS;
1650 else if (!strcmp (proto_str, "SRTP"))
1651 *proto = VPPCOM_PROTO_SRTP;
1652 else if (!strcmp (proto_str, "srtp"))
1653 *proto = VPPCOM_PROTO_SRTP;
1660 vppcom_session_accept (uint32_t listen_session_handle, vppcom_endpt_t * ep,
1663 u32 client_session_index = ~0, listen_session_index, accept_flags = 0;
1664 vcl_worker_t *wrk = vcl_worker_get_current ();
1665 session_accepted_msg_t accepted_msg;
1666 vcl_session_t *listen_session = 0;
1667 vcl_session_t *client_session = 0;
1668 vcl_session_msg_t *evt;
1674 listen_session = vcl_session_get_w_handle (wrk, listen_session_handle);
1675 if (!listen_session)
1676 return VPPCOM_EBADFD;
1678 listen_session_index = listen_session->session_index;
1679 if ((rv = validate_args_session_accept_ (wrk, listen_session)))
1682 if (clib_fifo_elts (listen_session->accept_evts_fifo))
1684 clib_fifo_sub2 (listen_session->accept_evts_fifo, evt);
1685 accept_flags = evt->flags;
1686 accepted_msg = evt->accepted_msg;
1690 is_nonblocking = vcl_session_has_attr (listen_session,
1691 VCL_SESS_ATTR_NONBLOCK);
1694 if (svm_msg_q_is_empty (wrk->app_event_queue) && is_nonblocking)
1695 return VPPCOM_EAGAIN;
1697 svm_msg_q_wait (wrk->app_event_queue, SVM_MQ_WAIT_EMPTY);
1698 vcl_worker_flush_mq_events (wrk);
1704 client_session_index = vcl_session_accepted_handler (wrk, &accepted_msg,
1705 listen_session_index);
1706 if (client_session_index == VCL_INVALID_SESSION_INDEX)
1707 return VPPCOM_ECONNABORTED;
1709 listen_session = vcl_session_get (wrk, listen_session_index);
1710 client_session = vcl_session_get (wrk, client_session_index);
1712 if (flags & O_NONBLOCK)
1713 vcl_session_set_attr (client_session, VCL_SESS_ATTR_NONBLOCK);
1715 VDBG (1, "listener %u [0x%llx]: Got a connect request! session %u [0x%llx],"
1716 " flags %d, is_nonblocking %u", listen_session->session_index,
1717 listen_session->vpp_handle, client_session_index,
1718 client_session->vpp_handle, flags,
1719 vcl_session_has_attr (client_session, VCL_SESS_ATTR_NONBLOCK));
1723 ep->is_ip4 = client_session->transport.is_ip4;
1724 ep->port = client_session->transport.rmt_port;
1725 if (client_session->transport.is_ip4)
1726 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip4,
1727 sizeof (ip4_address_t));
1729 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip6,
1730 sizeof (ip6_address_t));
1734 "listener %u [0x%llx] accepted %u [0x%llx] peer: %U:%u "
1736 listen_session_handle, listen_session->vpp_handle,
1737 client_session_index, client_session->vpp_handle,
1738 vcl_format_ip46_address, &client_session->transport.rmt_ip,
1739 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1740 clib_net_to_host_u16 (client_session->transport.rmt_port),
1741 vcl_format_ip46_address, &client_session->transport.lcl_ip,
1742 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1743 clib_net_to_host_u16 (client_session->transport.lcl_port));
1744 vcl_evt (VCL_EVT_ACCEPT, client_session, listen_session,
1745 client_session_index);
1748 * Session might have been closed already
1752 if (accept_flags & VCL_ACCEPTED_F_CLOSED)
1753 client_session->session_state = VCL_STATE_VPP_CLOSING;
1754 else if (accept_flags & VCL_ACCEPTED_F_RESET)
1755 client_session->session_state = VCL_STATE_DISCONNECT;
1757 return vcl_session_handle (client_session);
1761 vppcom_session_connect (uint32_t session_handle, vppcom_endpt_t * server_ep)
1763 vcl_worker_t *wrk = vcl_worker_get_current ();
1764 vcl_session_t *session = 0;
1768 session = vcl_session_get_w_handle (wrk, session_handle);
1770 return VPPCOM_EBADFD;
1771 session_index = session->session_index;
1773 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1775 VDBG (0, "ERROR: cannot connect epoll session %u!",
1776 session->session_index);
1777 return VPPCOM_EBADFD;
1780 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1783 "session handle %u [0x%llx]: session already "
1784 "connected to %s %U port %d proto %s, state 0x%x (%s)",
1785 session_handle, session->vpp_handle,
1786 session->transport.is_ip4 ? "IPv4" : "IPv6",
1787 vcl_format_ip46_address, &session->transport.rmt_ip,
1788 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1789 clib_net_to_host_u16 (session->transport.rmt_port),
1790 vppcom_proto_str (session->session_type), session->session_state,
1791 vcl_session_state_str (session->session_state));
1795 /* Attempt to connect a connectionless listener */
1796 if (PREDICT_FALSE (session->session_state == VCL_STATE_LISTEN))
1798 if (session->session_type != VPPCOM_PROTO_UDP)
1799 return VPPCOM_EINVAL;
1800 vcl_send_session_unlisten (wrk, session);
1801 session->session_state = VCL_STATE_CLOSED;
1804 session->transport.is_ip4 = server_ep->is_ip4;
1805 vcl_ip_copy_from_ep (&session->transport.rmt_ip, server_ep);
1806 session->transport.rmt_port = server_ep->port;
1807 session->parent_handle = VCL_INVALID_SESSION_HANDLE;
1808 session->flags |= VCL_SESSION_F_CONNECTED;
1811 "session handle %u (%s): connecting to peer %s %U "
1813 session_handle, vcl_session_state_str (session->session_state),
1814 session->transport.is_ip4 ? "IPv4" : "IPv6", vcl_format_ip46_address,
1815 &session->transport.rmt_ip,
1816 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1817 clib_net_to_host_u16 (session->transport.rmt_port),
1818 vppcom_proto_str (session->session_type));
1820 vcl_send_session_connect (wrk, session);
1822 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK))
1824 /* State set to STATE_UPDATED to ensure the session is not assumed
1825 * to be ready and to also allow the app to close it prior to vpp's
1826 * connected reply. */
1827 session->session_state = VCL_STATE_UPDATED;
1828 return VPPCOM_EINPROGRESS;
1832 * Wait for reply from vpp if blocking
1834 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1835 vcm->cfg.session_timeout);
1837 session = vcl_session_get (wrk, session_index);
1838 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1839 session->vpp_handle, rv ? "failed" : "succeeded");
1845 vppcom_session_stream_connect (uint32_t session_handle,
1846 uint32_t parent_session_handle)
1848 vcl_worker_t *wrk = vcl_worker_get_current ();
1849 vcl_session_t *session, *parent_session;
1850 u32 session_index, parent_session_index;
1853 session = vcl_session_get_w_handle (wrk, session_handle);
1855 return VPPCOM_EBADFD;
1856 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1857 if (!parent_session)
1858 return VPPCOM_EBADFD;
1860 session_index = session->session_index;
1861 parent_session_index = parent_session->session_index;
1862 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1864 VDBG (0, "ERROR: cannot connect epoll session %u!",
1865 session->session_index);
1866 return VPPCOM_EBADFD;
1869 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1872 "session handle %u [0x%llx]: session already "
1873 "connected to session %u [0x%llx] proto %s, state 0x%x (%s)",
1874 session_handle, session->vpp_handle, parent_session_handle,
1875 parent_session->vpp_handle,
1876 vppcom_proto_str (session->session_type), session->session_state,
1877 vcl_session_state_str (session->session_state));
1881 /* Connect to quic session specifics */
1882 session->transport.is_ip4 = parent_session->transport.is_ip4;
1883 session->transport.rmt_ip.ip4.as_u32 = (uint32_t) 1;
1884 session->transport.rmt_port = 0;
1885 session->parent_handle = parent_session->vpp_handle;
1887 VDBG (0, "session handle %u: connecting to session %u [0x%llx]",
1888 session_handle, parent_session_handle, parent_session->vpp_handle);
1891 * Send connect request and wait for reply from vpp
1893 vcl_send_session_connect (wrk, session);
1894 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1895 vcm->cfg.session_timeout);
1897 session->listener_index = parent_session_index;
1898 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1900 parent_session->n_accepted_sessions++;
1902 session = vcl_session_get (wrk, session_index);
1903 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1904 session->vpp_handle, rv ? "failed" : "succeeded");
1910 vppcom_session_read_internal (uint32_t session_handle, void *buf, int n,
1913 vcl_worker_t *wrk = vcl_worker_get_current ();
1914 int rv, n_read = 0, is_nonblocking;
1915 vcl_session_t *s = 0;
1916 svm_fifo_t *rx_fifo;
1921 if (PREDICT_FALSE (!buf))
1922 return VPPCOM_EFAULT;
1924 s = vcl_session_get_w_handle (wrk, session_handle);
1925 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
1926 return VPPCOM_EBADFD;
1928 if (PREDICT_FALSE (!vcl_session_is_open (s)))
1930 VDBG (0, "session %u[0x%llx] is not open! state 0x%x (%s)",
1931 s->session_index, s->vpp_handle, s->session_state,
1932 vcl_session_state_str (s->session_state));
1933 return vcl_session_closed_error (s);
1936 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_RD_SHUTDOWN))
1938 /* Vpp would ack the incoming data and enqueue it for reading.
1939 * So even if SHUT_RD is set, we can still read() the data if
1940 * the session is ready.
1942 if (!vcl_session_read_ready (s))
1948 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
1949 is_ct = vcl_session_is_ct (s);
1950 mq = wrk->app_event_queue;
1951 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
1952 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
1954 if (svm_fifo_is_empty_cons (rx_fifo))
1958 if (vcl_session_is_closing (s))
1959 return vcl_session_closing_error (s);
1961 svm_fifo_unset_event (s->rx_fifo);
1962 svm_fifo_unset_event (rx_fifo);
1963 return VPPCOM_EWOULDBLOCK;
1965 while (svm_fifo_is_empty_cons (rx_fifo))
1967 if (vcl_session_is_closing (s))
1968 return vcl_session_closing_error (s);
1971 svm_fifo_unset_event (s->rx_fifo);
1972 svm_fifo_unset_event (rx_fifo);
1974 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
1975 vcl_worker_flush_mq_events (wrk);
1982 rv = app_recv_dgram_raw (rx_fifo, buf, n, &s->transport, 0, peek);
1984 rv = app_recv_stream_raw (rx_fifo, buf, n, 0, peek);
1993 if (svm_fifo_is_empty_cons (rx_fifo))
1996 svm_fifo_unset_event (s->rx_fifo);
1997 svm_fifo_unset_event (rx_fifo);
1998 if (!svm_fifo_is_empty_cons (rx_fifo)
1999 && svm_fifo_set_event (rx_fifo) && is_nonblocking)
2001 vec_add2 (wrk->unhandled_evts_vector, e, 1);
2002 e->event_type = SESSION_IO_EVT_RX;
2003 e->session_index = s->session_index;
2006 else if (PREDICT_FALSE (rv < n && !s->is_dgram))
2008 /* More data enqueued while reading. Try to drain it
2009 * or fill the buffer. Avoid doing that for dgrams */
2015 if (PREDICT_FALSE (svm_fifo_needs_deq_ntf (rx_fifo, n_read)))
2017 svm_fifo_clear_deq_ntf (rx_fifo);
2018 app_send_io_evt_to_vpp (s->vpp_evt_q,
2019 s->rx_fifo->shr->master_session_index,
2020 SESSION_IO_EVT_RX, SVM_Q_WAIT);
2023 VDBG (2, "session %u[0x%llx]: read %d bytes from (%p)", s->session_index,
2024 s->vpp_handle, n_read, rx_fifo);
2030 vppcom_session_read (uint32_t session_handle, void *buf, size_t n)
2032 return (vppcom_session_read_internal (session_handle, buf, n, 0));
2036 vppcom_session_peek (uint32_t session_handle, void *buf, int n)
2038 return (vppcom_session_read_internal (session_handle, buf, n, 1));
2042 vppcom_session_read_segments (uint32_t session_handle,
2043 vppcom_data_segment_t * ds, uint32_t n_segments,
2046 vcl_worker_t *wrk = vcl_worker_get_current ();
2047 int n_read = 0, is_nonblocking;
2048 vcl_session_t *s = 0;
2049 svm_fifo_t *rx_fifo;
2053 s = vcl_session_get_w_handle (wrk, session_handle);
2054 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2055 return VPPCOM_EBADFD;
2057 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2058 return vcl_session_closed_error (s);
2060 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2061 is_ct = vcl_session_is_ct (s);
2062 mq = wrk->app_event_queue;
2063 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
2064 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2066 if (svm_fifo_is_empty_cons (rx_fifo))
2071 svm_fifo_unset_event (s->rx_fifo);
2072 svm_fifo_unset_event (rx_fifo);
2073 return VPPCOM_EWOULDBLOCK;
2075 while (svm_fifo_is_empty_cons (rx_fifo))
2077 if (vcl_session_is_closing (s))
2078 return vcl_session_closing_error (s);
2081 svm_fifo_unset_event (s->rx_fifo);
2082 svm_fifo_unset_event (rx_fifo);
2084 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2085 vcl_worker_flush_mq_events (wrk);
2089 n_read = svm_fifo_segments (rx_fifo, s->rx_bytes_pending,
2090 (svm_fifo_seg_t *) ds, n_segments, max_bytes);
2092 return VPPCOM_EAGAIN;
2094 if (svm_fifo_max_dequeue_cons (rx_fifo) == n_read)
2097 svm_fifo_unset_event (s->rx_fifo);
2098 svm_fifo_unset_event (rx_fifo);
2099 if (svm_fifo_max_dequeue_cons (rx_fifo) != n_read
2100 && svm_fifo_set_event (rx_fifo)
2101 && vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
2104 vec_add2 (wrk->unhandled_evts_vector, e, 1);
2105 e->event_type = SESSION_IO_EVT_RX;
2106 e->session_index = s->session_index;
2110 s->rx_bytes_pending += n_read;
2115 vppcom_session_free_segments (uint32_t session_handle, uint32_t n_bytes)
2117 vcl_worker_t *wrk = vcl_worker_get_current ();
2121 s = vcl_session_get_w_handle (wrk, session_handle);
2122 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2125 is_ct = vcl_session_is_ct (s);
2126 svm_fifo_dequeue_drop (is_ct ? s->ct_rx_fifo : s->rx_fifo, n_bytes);
2128 ASSERT (s->rx_bytes_pending >= n_bytes);
2129 s->rx_bytes_pending -= n_bytes;
2133 vcl_fifo_is_writeable (svm_fifo_t * f, u32 len, u8 is_dgram)
2135 u32 max_enq = svm_fifo_max_enqueue_prod (f);
2137 return max_enq >= (sizeof (session_dgram_hdr_t) + len);
2143 vppcom_session_write_inline (vcl_worker_t * wrk, vcl_session_t * s, void *buf,
2144 size_t n, u8 is_flush, u8 is_dgram)
2146 int n_write, is_nonblocking;
2147 session_evt_type_t et;
2148 svm_fifo_t *tx_fifo;
2152 /* Accept zero length writes but just return */
2153 if (PREDICT_FALSE (!n))
2156 if (PREDICT_FALSE (!buf))
2157 return VPPCOM_EFAULT;
2159 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2161 VDBG (0, "ERROR: session %u [0x%llx]: cannot write to an epoll"
2162 " session!", s->session_index, s->vpp_handle);
2163 return VPPCOM_EBADFD;
2166 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2168 VDBG (1, "session %u [0x%llx]: is not open! state 0x%x (%s)",
2169 s->session_index, s->vpp_handle, s->session_state,
2170 vcl_session_state_str (s->session_state));
2171 return vcl_session_closed_error (s);;
2174 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_WR_SHUTDOWN))
2176 VDBG (1, "session %u [0x%llx]: is shutdown! state 0x%x (%s)",
2177 s->session_index, s->vpp_handle, s->session_state,
2178 vcl_session_state_str (s->session_state));
2179 return VPPCOM_EPIPE;
2182 is_ct = vcl_session_is_ct (s);
2183 tx_fifo = is_ct ? s->ct_tx_fifo : s->tx_fifo;
2184 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2186 mq = wrk->app_event_queue;
2187 if (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2191 return VPPCOM_EWOULDBLOCK;
2193 while (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2195 svm_fifo_add_want_deq_ntf (tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
2196 if (vcl_session_is_closing (s))
2197 return vcl_session_closing_error (s);
2199 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2200 vcl_worker_flush_mq_events (wrk);
2204 et = SESSION_IO_EVT_TX;
2205 if (is_flush && !is_ct)
2206 et = SESSION_IO_EVT_TX_FLUSH;
2209 n_write = app_send_dgram_raw (tx_fifo, &s->transport,
2210 s->vpp_evt_q, buf, n, et,
2211 0 /* do_evt */ , SVM_Q_WAIT);
2213 n_write = app_send_stream_raw (tx_fifo, s->vpp_evt_q, buf, n, et,
2214 0 /* do_evt */ , SVM_Q_WAIT);
2216 if (svm_fifo_set_event (s->tx_fifo))
2217 app_send_io_evt_to_vpp (
2218 s->vpp_evt_q, s->tx_fifo->shr->master_session_index, et, SVM_Q_WAIT);
2220 /* The underlying fifo segment can run out of memory */
2221 if (PREDICT_FALSE (n_write < 0))
2222 return VPPCOM_EAGAIN;
2224 VDBG (2, "session %u [0x%llx]: wrote %d bytes", s->session_index,
2225 s->vpp_handle, n_write);
2231 vppcom_session_write (uint32_t session_handle, void *buf, size_t n)
2233 vcl_worker_t *wrk = vcl_worker_get_current ();
2236 s = vcl_session_get_w_handle (wrk, session_handle);
2237 if (PREDICT_FALSE (!s))
2238 return VPPCOM_EBADFD;
2240 return vppcom_session_write_inline (wrk, s, buf, n,
2241 0 /* is_flush */ , s->is_dgram ? 1 : 0);
2245 vppcom_session_write_msg (uint32_t session_handle, void *buf, size_t n)
2247 vcl_worker_t *wrk = vcl_worker_get_current ();
2250 s = vcl_session_get_w_handle (wrk, session_handle);
2251 if (PREDICT_FALSE (!s))
2252 return VPPCOM_EBADFD;
2254 return vppcom_session_write_inline (wrk, s, buf, n,
2255 1 /* is_flush */ , s->is_dgram ? 1 : 0);
2258 #define vcl_fifo_rx_evt_valid_or_break(_s) \
2259 if (PREDICT_FALSE (!_s->rx_fifo)) \
2261 if (PREDICT_FALSE (svm_fifo_is_empty (_s->rx_fifo))) \
2263 if (!vcl_session_is_ct (_s)) \
2265 svm_fifo_unset_event (_s->rx_fifo); \
2266 if (svm_fifo_is_empty (_s->rx_fifo)) \
2269 else if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2271 svm_fifo_unset_event (_s->rx_fifo); /* rx evts on actual fifo*/ \
2272 if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2278 vcl_select_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2279 unsigned long n_bits, unsigned long *read_map,
2280 unsigned long *write_map,
2281 unsigned long *except_map, u32 * bits_set)
2283 session_disconnected_msg_t *disconnected_msg;
2284 session_connected_msg_t *connected_msg;
2288 switch (e->event_type)
2290 case SESSION_IO_EVT_RX:
2291 sid = e->session_index;
2292 s = vcl_session_get (wrk, sid);
2293 if (!s || !vcl_session_is_open (s))
2295 vcl_fifo_rx_evt_valid_or_break (s);
2296 if (sid < n_bits && read_map)
2298 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2302 case SESSION_IO_EVT_TX:
2303 sid = e->session_index;
2304 s = vcl_session_get (wrk, sid);
2305 if (!s || !vcl_session_is_open (s))
2307 if (sid < n_bits && write_map)
2309 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2313 case SESSION_CTRL_EVT_ACCEPTED:
2315 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
2317 s = vcl_session_get (wrk, e->session_index);
2320 sid = s->session_index;
2321 if (sid < n_bits && read_map)
2323 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2327 case SESSION_CTRL_EVT_CONNECTED:
2330 connected_msg = (session_connected_msg_t *) e->data;
2331 sid = vcl_session_connected_handler (wrk, connected_msg);
2334 sid = e->session_index;
2335 if (sid == VCL_INVALID_SESSION_INDEX)
2337 if (sid < n_bits && write_map)
2339 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2343 case SESSION_CTRL_EVT_DISCONNECTED:
2344 disconnected_msg = (session_disconnected_msg_t *) e->data;
2345 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
2348 sid = s->session_index;
2349 if (sid < n_bits && except_map)
2351 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2355 case SESSION_CTRL_EVT_RESET:
2356 sid = vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
2357 if (sid < n_bits && except_map)
2359 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2363 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
2364 vcl_session_unlisten_reply_handler (wrk, e->data);
2366 case SESSION_CTRL_EVT_MIGRATED:
2367 vcl_session_migrated_handler (wrk, e->data);
2369 case SESSION_CTRL_EVT_CLEANUP:
2370 vcl_session_cleanup_handler (wrk, e->data);
2372 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
2373 vcl_session_worker_update_reply_handler (wrk, e->data);
2375 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
2376 vcl_session_req_worker_update_handler (wrk, e->data);
2378 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
2379 vcl_session_app_add_segment_handler (wrk, e->data);
2381 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
2382 vcl_session_app_del_segment_handler (wrk, e->data);
2384 case SESSION_CTRL_EVT_APP_WRK_RPC:
2385 vcl_worker_rpc_handler (wrk, e->data);
2388 clib_warning ("unhandled: %u", e->event_type);
2394 vcl_select_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
2395 unsigned long n_bits, unsigned long *read_map,
2396 unsigned long *write_map, unsigned long *except_map,
2397 double time_to_wait, u32 * bits_set)
2399 svm_msg_q_msg_t *msg;
2403 if (svm_msg_q_is_empty (mq))
2410 else if (time_to_wait < 0)
2411 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2414 if (svm_msg_q_timedwait (mq, time_to_wait))
2418 vcl_mq_dequeue_batch (wrk, mq, ~0);
2420 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
2422 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
2423 e = svm_msg_q_msg_data (mq, msg);
2424 vcl_select_handle_mq_event (wrk, e, n_bits, read_map, write_map,
2425 except_map, bits_set);
2426 svm_msg_q_free_msg (mq, msg);
2428 vec_reset_length (wrk->mq_msg_vector);
2429 vcl_handle_pending_wrk_updates (wrk);
2434 vppcom_select_condvar (vcl_worker_t * wrk, int n_bits,
2435 vcl_si_set * read_map, vcl_si_set * write_map,
2436 vcl_si_set * except_map, double time_to_wait,
2439 double wait = 0, start = 0;
2443 wait = time_to_wait;
2444 start = clib_time_now (&wrk->clib_time);
2449 vcl_select_handle_mq (wrk, wrk->app_event_queue, n_bits, read_map,
2450 write_map, except_map, wait, bits_set);
2456 wait = wait - (clib_time_now (&wrk->clib_time) - start);
2464 vppcom_select_eventfd (vcl_worker_t * wrk, int n_bits,
2465 vcl_si_set * read_map, vcl_si_set * write_map,
2466 vcl_si_set * except_map, double time_to_wait,
2469 vcl_mq_evt_conn_t *mqc;
2470 int __clib_unused n_read;
2474 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
2475 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
2476 vec_len (wrk->mq_events), time_to_wait);
2477 for (i = 0; i < n_mq_evts; i++)
2479 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
2480 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
2481 vcl_select_handle_mq (wrk, mqc->mq, n_bits, read_map, write_map,
2482 except_map, 0, bits_set);
2485 return (n_mq_evts > 0 ? (int) *bits_set : 0);
2489 vppcom_select (int n_bits, vcl_si_set * read_map, vcl_si_set * write_map,
2490 vcl_si_set * except_map, double time_to_wait)
2492 u32 sid, minbits = clib_max (n_bits, BITS (uword)), bits_set = 0;
2493 vcl_worker_t *wrk = vcl_worker_get_current ();
2494 vcl_session_t *s = 0;
2497 if (n_bits && read_map)
2499 clib_bitmap_validate (wrk->rd_bitmap, minbits);
2500 clib_memcpy_fast (wrk->rd_bitmap, read_map,
2501 vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2502 memset (read_map, 0, vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2504 if (n_bits && write_map)
2506 clib_bitmap_validate (wrk->wr_bitmap, minbits);
2507 clib_memcpy_fast (wrk->wr_bitmap, write_map,
2508 vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2509 memset (write_map, 0, vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2511 if (n_bits && except_map)
2513 clib_bitmap_validate (wrk->ex_bitmap, minbits);
2514 clib_memcpy_fast (wrk->ex_bitmap, except_map,
2515 vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2516 memset (except_map, 0, vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2525 clib_bitmap_foreach (sid, wrk->wr_bitmap)
2527 if (!(s = vcl_session_get (wrk, sid)))
2529 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2534 if (vcl_session_write_ready (s))
2536 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2541 svm_fifo_t *txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2542 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF);
2550 clib_bitmap_foreach (sid, wrk->rd_bitmap)
2552 if (!(s = vcl_session_get (wrk, sid)))
2554 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2559 if (vcl_session_read_ready (s))
2561 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2568 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
2570 vcl_select_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i], n_bits,
2571 read_map, write_map, except_map, &bits_set);
2573 vec_reset_length (wrk->unhandled_evts_vector);
2575 if (vcm->cfg.use_mq_eventfd)
2576 vppcom_select_eventfd (wrk, n_bits, read_map, write_map, except_map,
2577 time_to_wait, &bits_set);
2579 vppcom_select_condvar (wrk, n_bits, read_map, write_map, except_map,
2580 time_to_wait, &bits_set);
2586 vep_verify_epoll_chain (vcl_worker_t * wrk, u32 vep_handle)
2588 vppcom_epoll_t *vep;
2589 u32 sh = vep_handle;
2592 if (VPPCOM_DEBUG <= 2)
2595 s = vcl_session_get_w_handle (wrk, vep_handle);
2596 if (PREDICT_FALSE (!s))
2598 VDBG (0, "ERROR: Invalid vep_sh (%u)!", vep_handle);
2601 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP)))
2603 VDBG (0, "ERROR: vep_sh (%u) is not a vep!", vep_handle);
2607 VDBG (0, "vep_sh (%u): Dumping epoll chain\n"
2610 " is_vep_session = %u\n"
2611 " next_sh = 0x%x (%u)\n"
2612 "}\n", vep_handle, s->flags & VCL_SESSION_F_IS_VEP,
2613 s->flags & VCL_SESSION_F_IS_VEP_SESSION, vep->next_sh, vep->next_sh);
2615 for (sh = vep->next_sh; sh != ~0; sh = vep->next_sh)
2617 s = vcl_session_get_w_handle (wrk, sh);
2618 if (PREDICT_FALSE (!s))
2620 VDBG (0, "ERROR: Invalid sh (%u)!", sh);
2623 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2625 VDBG (0, "ERROR: sh (%u) is a vep!", vep_handle);
2627 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2629 VDBG (0, "ERROR: sh (%u) is not a vep session handle!", sh);
2633 if (PREDICT_FALSE (vep->vep_sh != vep_handle))
2634 VDBG (0, "ERROR: session (%u) vep_sh (%u) != vep_sh (%u)!",
2635 sh, s->vep.vep_sh, vep_handle);
2636 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2638 VDBG (0, "vep_sh[%u]: sh 0x%x (%u)\n"
2640 " next_sh = 0x%x (%u)\n"
2641 " prev_sh = 0x%x (%u)\n"
2642 " vep_sh = 0x%x (%u)\n"
2643 " ev.events = 0x%x\n"
2644 " ev.data.u64 = 0x%llx\n"
2647 vep_handle, sh, sh, vep->next_sh, vep->next_sh, vep->prev_sh,
2648 vep->prev_sh, vep->vep_sh, vep->vep_sh, vep->ev.events,
2649 vep->ev.data.u64, vep->et_mask);
2654 VDBG (0, "vep_sh (%u): Dump complete!\n", vep_handle);
2658 vppcom_epoll_create (void)
2660 vcl_worker_t *wrk = vcl_worker_get_current ();
2661 vcl_session_t *vep_session;
2663 vep_session = vcl_session_alloc (wrk);
2665 vep_session->flags |= VCL_SESSION_F_IS_VEP;
2666 vep_session->vep.vep_sh = ~0;
2667 vep_session->vep.next_sh = ~0;
2668 vep_session->vep.prev_sh = ~0;
2669 vep_session->vpp_handle = ~0;
2671 vcl_evt (VCL_EVT_EPOLL_CREATE, vep_session, vep_session->session_index);
2672 VDBG (0, "Created vep_idx %u", vep_session->session_index);
2674 return vcl_session_handle (vep_session);
2678 vppcom_epoll_ctl (uint32_t vep_handle, int op, uint32_t session_handle,
2679 struct epoll_event *event)
2681 vcl_worker_t *wrk = vcl_worker_get_current ();
2682 int rv = VPPCOM_OK, add_evt = 0;
2683 vcl_session_t *vep_session;
2687 if (vep_handle == session_handle)
2689 VDBG (0, "vep_sh == session handle (%u)!", vep_handle);
2690 return VPPCOM_EINVAL;
2693 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
2694 if (PREDICT_FALSE (!vep_session))
2696 VDBG (0, "Invalid vep_sh (%u)!", vep_handle);
2697 return VPPCOM_EBADFD;
2699 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
2701 VDBG (0, "vep_sh (%u) is not a vep!", vep_handle);
2702 return VPPCOM_EINVAL;
2705 ASSERT (vep_session->vep.vep_sh == ~0);
2706 ASSERT (vep_session->vep.prev_sh == ~0);
2708 s = vcl_session_get_w_handle (wrk, session_handle);
2709 if (PREDICT_FALSE (!s))
2711 VDBG (0, "Invalid session_handle (%u)!", session_handle);
2712 return VPPCOM_EBADFD;
2714 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2716 VDBG (0, "session_handle (%u) is a vep!", vep_handle);
2717 return VPPCOM_EINVAL;
2723 if (PREDICT_FALSE (!event))
2725 VDBG (0, "EPOLL_CTL_ADD: NULL pointer to epoll_event structure!");
2726 return VPPCOM_EINVAL;
2728 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2730 VDBG (0, "EPOLL_CTL_ADD: %u already epolled!", s->session_index);
2734 if (vep_session->vep.next_sh != ~0)
2736 vcl_session_t *next_session;
2737 next_session = vcl_session_get_w_handle (wrk,
2738 vep_session->vep.next_sh);
2739 if (PREDICT_FALSE (!next_session))
2741 VDBG (0, "EPOLL_CTL_ADD: Invalid vep.next_sh (%u) on "
2742 "vep_idx (%u)!", vep_session->vep.next_sh, vep_handle);
2743 return VPPCOM_EBADFD;
2745 ASSERT (next_session->vep.prev_sh == vep_handle);
2746 next_session->vep.prev_sh = session_handle;
2748 s->vep.next_sh = vep_session->vep.next_sh;
2749 s->vep.prev_sh = vep_handle;
2750 s->vep.vep_sh = vep_handle;
2751 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2752 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
2754 s->flags &= ~VCL_SESSION_F_IS_VEP;
2755 s->flags |= VCL_SESSION_F_IS_VEP_SESSION;
2756 vep_session->vep.next_sh = session_handle;
2758 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2759 if (txf && (event->events & EPOLLOUT))
2760 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2762 /* Generate EPOLLOUT if tx fifo not full */
2763 if ((event->events & EPOLLOUT) && (vcl_session_write_ready (s) > 0))
2765 session_event_t e = { 0 };
2766 e.event_type = SESSION_IO_EVT_TX;
2767 e.session_index = s->session_index;
2768 vec_add1 (wrk->unhandled_evts_vector, e);
2771 /* Generate EPOLLIN if rx fifo has data */
2772 if ((event->events & EPOLLIN) && (vcl_session_read_ready (s) > 0))
2774 session_event_t e = { 0 };
2775 e.event_type = SESSION_IO_EVT_RX;
2776 e.session_index = s->session_index;
2777 vec_add1 (wrk->unhandled_evts_vector, e);
2778 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2781 if (!add_evt && vcl_session_is_closing (s))
2783 session_event_t e = { 0 };
2784 if (s->session_state == VCL_STATE_VPP_CLOSING)
2785 e.event_type = SESSION_CTRL_EVT_DISCONNECTED;
2787 e.event_type = SESSION_CTRL_EVT_RESET;
2788 e.session_index = s->session_index;
2790 vec_add1 (wrk->unhandled_evts_vector, e);
2792 VDBG (1, "EPOLL_CTL_ADD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2793 vep_handle, session_handle, event->events, event->data.u64);
2794 vcl_evt (VCL_EVT_EPOLL_CTLADD, s, event->events, event->data.u64);
2798 if (PREDICT_FALSE (!event))
2800 VDBG (0, "EPOLL_CTL_MOD: NULL pointer to epoll_event structure!");
2804 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2806 VDBG (0, "sh %u EPOLL_CTL_MOD: not a vep session!", session_handle);
2810 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2812 VDBG (0, "EPOLL_CTL_MOD: sh %u vep_sh (%u) != vep_sh (%u)!",
2813 session_handle, s->vep.vep_sh, vep_handle);
2818 /* Generate EPOLLOUT if session write ready nd event was not on */
2819 if ((event->events & EPOLLOUT) && !(s->vep.ev.events & EPOLLOUT) &&
2820 (vcl_session_write_ready (s) > 0))
2822 session_event_t e = { 0 };
2823 e.event_type = SESSION_IO_EVT_TX;
2824 e.session_index = s->session_index;
2825 vec_add1 (wrk->unhandled_evts_vector, e);
2827 /* Generate EPOLLIN if session read ready and event was not on */
2828 if ((event->events & EPOLLIN) && !(s->vep.ev.events & EPOLLIN) &&
2829 (vcl_session_read_ready (s) > 0))
2831 session_event_t e = { 0 };
2832 e.event_type = SESSION_IO_EVT_RX;
2833 e.session_index = s->session_index;
2834 vec_add1 (wrk->unhandled_evts_vector, e);
2835 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2837 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2839 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2842 if (event->events & EPOLLOUT)
2843 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2845 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2847 VDBG (1, "EPOLL_CTL_MOD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2848 vep_handle, session_handle, event->events, event->data.u64);
2852 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2854 VDBG (0, "EPOLL_CTL_DEL: %u not a vep session!", session_handle);
2858 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2860 VDBG (0, "EPOLL_CTL_DEL: sh %u vep_sh (%u) != vep_sh (%u)!",
2861 session_handle, s->vep.vep_sh, vep_handle);
2866 if (s->vep.prev_sh == vep_handle)
2867 vep_session->vep.next_sh = s->vep.next_sh;
2870 vcl_session_t *prev_session;
2871 prev_session = vcl_session_get_w_handle (wrk, s->vep.prev_sh);
2872 if (PREDICT_FALSE (!prev_session))
2874 VDBG (0, "EPOLL_CTL_DEL: Invalid prev_sh (%u) on sh (%u)!",
2875 s->vep.prev_sh, session_handle);
2876 return VPPCOM_EBADFD;
2878 ASSERT (prev_session->vep.next_sh == session_handle);
2879 prev_session->vep.next_sh = s->vep.next_sh;
2881 if (s->vep.next_sh != ~0)
2883 vcl_session_t *next_session;
2884 next_session = vcl_session_get_w_handle (wrk, s->vep.next_sh);
2885 if (PREDICT_FALSE (!next_session))
2887 VDBG (0, "EPOLL_CTL_DEL: Invalid next_sh (%u) on sh (%u)!",
2888 s->vep.next_sh, session_handle);
2889 return VPPCOM_EBADFD;
2891 ASSERT (next_session->vep.prev_sh == session_handle);
2892 next_session->vep.prev_sh = s->vep.prev_sh;
2895 if (s->vep.lt_next != VCL_INVALID_SESSION_INDEX)
2896 vcl_epoll_lt_del (wrk, s);
2898 memset (&s->vep, 0, sizeof (s->vep));
2899 s->vep.next_sh = ~0;
2900 s->vep.prev_sh = ~0;
2902 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
2903 s->flags &= ~VCL_SESSION_F_IS_VEP_SESSION;
2905 if (vcl_session_is_open (s))
2907 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2909 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2912 VDBG (1, "EPOLL_CTL_DEL: vep_idx %u, sh %u!", vep_handle,
2914 vcl_evt (VCL_EVT_EPOLL_CTLDEL, s, vep_sh);
2918 VDBG (0, "Invalid operation (%d)!", op);
2922 vep_verify_epoll_chain (wrk, vep_handle);
2929 vcl_epoll_wait_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2930 struct epoll_event *events, u32 * num_ev)
2932 session_disconnected_msg_t *disconnected_msg;
2933 session_connected_msg_t *connected_msg;
2934 u32 sid = ~0, session_events;
2935 u64 session_evt_data = ~0;
2939 switch (e->event_type)
2941 case SESSION_IO_EVT_RX:
2942 sid = e->session_index;
2943 s = vcl_session_get (wrk, sid);
2944 if (vcl_session_is_closed (s))
2946 vcl_fifo_rx_evt_valid_or_break (s);
2947 session_events = s->vep.ev.events;
2948 if (!(EPOLLIN & s->vep.ev.events) ||
2949 (s->flags & VCL_SESSION_F_HAS_RX_EVT) ||
2950 (s->vep.lt_next != VCL_INVALID_SESSION_INDEX))
2953 events[*num_ev].events = EPOLLIN;
2954 session_evt_data = s->vep.ev.data.u64;
2955 s->flags |= VCL_SESSION_F_HAS_RX_EVT;
2957 case SESSION_IO_EVT_TX:
2958 sid = e->session_index;
2959 s = vcl_session_get (wrk, sid);
2960 if (!s || !vcl_session_is_open (s))
2962 session_events = s->vep.ev.events;
2963 if (!(EPOLLOUT & session_events))
2966 events[*num_ev].events = EPOLLOUT;
2967 session_evt_data = s->vep.ev.data.u64;
2968 svm_fifo_reset_has_deq_ntf (vcl_session_is_ct (s) ?
2969 s->ct_tx_fifo : s->tx_fifo);
2971 case SESSION_CTRL_EVT_ACCEPTED:
2973 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
2975 s = vcl_session_get (wrk, e->session_index);
2978 session_events = s->vep.ev.events;
2979 sid = s->session_index;
2980 if (!(EPOLLIN & session_events) ||
2981 (s->vep.lt_next != VCL_INVALID_SESSION_INDEX))
2984 events[*num_ev].events = EPOLLIN;
2985 session_evt_data = s->vep.ev.data.u64;
2987 case SESSION_CTRL_EVT_CONNECTED:
2990 connected_msg = (session_connected_msg_t *) e->data;
2991 sid = vcl_session_connected_handler (wrk, connected_msg);
2994 sid = e->session_index;
2995 s = vcl_session_get (wrk, sid);
2996 if (vcl_session_is_closed (s))
2998 session_events = s->vep.ev.events;
2999 /* Generate EPOLLOUT because there's no connected event */
3000 if (!(EPOLLOUT & session_events))
3003 events[*num_ev].events = EPOLLOUT;
3004 session_evt_data = s->vep.ev.data.u64;
3005 if (s->session_state == VCL_STATE_DETACHED)
3006 events[*num_ev].events |= EPOLLHUP;
3008 case SESSION_CTRL_EVT_DISCONNECTED:
3011 disconnected_msg = (session_disconnected_msg_t *) e->data;
3012 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
3016 s = vcl_session_get (wrk, e->session_index);
3017 s->flags &= ~VCL_SESSION_F_PENDING_DISCONNECT;
3019 if (vcl_session_is_closed (s) ||
3020 !(s->flags & VCL_SESSION_F_IS_VEP_SESSION))
3022 if (s->flags & VCL_SESSION_F_PENDING_FREE)
3023 vcl_session_free (wrk, s);
3026 sid = s->session_index;
3027 session_events = s->vep.ev.events;
3029 if (EPOLLRDHUP & session_events)
3031 /* If app can distinguish between RDHUP and HUP,
3032 * we make finer control */
3033 events[*num_ev].events = EPOLLRDHUP;
3034 if (s->flags & VCL_SESSION_F_WR_SHUTDOWN)
3036 events[*num_ev].events |= EPOLLHUP;
3041 events[*num_ev].events = EPOLLHUP;
3043 session_evt_data = s->vep.ev.data.u64;
3046 case SESSION_CTRL_EVT_RESET:
3050 vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
3051 s = vcl_session_get (wrk, sid);
3055 sid = e->session_index;
3056 s = vcl_session_get (wrk, sid);
3057 s->flags &= ~VCL_SESSION_F_PENDING_DISCONNECT;
3059 if (vcl_session_is_closed (s) ||
3060 !(s->flags & VCL_SESSION_F_IS_VEP_SESSION))
3062 if (s->flags & VCL_SESSION_F_PENDING_FREE)
3063 vcl_session_free (wrk, s);
3066 session_events = s->vep.ev.events;
3068 events[*num_ev].events = EPOLLHUP | EPOLLRDHUP;
3069 session_evt_data = s->vep.ev.data.u64;
3071 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
3072 vcl_session_unlisten_reply_handler (wrk, e->data);
3074 case SESSION_CTRL_EVT_MIGRATED:
3075 vcl_session_migrated_handler (wrk, e->data);
3077 case SESSION_CTRL_EVT_CLEANUP:
3078 vcl_session_cleanup_handler (wrk, e->data);
3080 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
3081 vcl_session_req_worker_update_handler (wrk, e->data);
3083 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
3084 vcl_session_worker_update_reply_handler (wrk, e->data);
3086 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
3087 vcl_session_app_add_segment_handler (wrk, e->data);
3089 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
3090 vcl_session_app_del_segment_handler (wrk, e->data);
3092 case SESSION_CTRL_EVT_APP_WRK_RPC:
3093 vcl_worker_rpc_handler (wrk, e->data);
3096 VDBG (0, "unhandled: %u", e->event_type);
3102 events[*num_ev].data.u64 = session_evt_data;
3103 if (EPOLLONESHOT & session_events)
3105 s = vcl_session_get (wrk, sid);
3106 s->vep.ev.events = 0;
3108 else if (!(EPOLLET & session_events))
3110 s = vcl_session_get (wrk, sid);
3111 if (s->vep.lt_next == VCL_INVALID_SESSION_INDEX)
3112 vcl_epoll_lt_add (wrk, s);
3119 vcl_epoll_wait_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
3120 struct epoll_event *events, u32 maxevents,
3121 double wait_for_time, u32 * num_ev)
3123 svm_msg_q_msg_t *msg;
3127 if (vec_len (wrk->mq_msg_vector) && svm_msg_q_is_empty (mq))
3128 goto handle_dequeued;
3130 if (svm_msg_q_is_empty (mq))
3134 else if (wait_for_time < 0)
3135 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
3138 if (svm_msg_q_timedwait (mq, wait_for_time / 1e3))
3142 ASSERT (maxevents > *num_ev);
3143 vcl_mq_dequeue_batch (wrk, mq, ~0);
3146 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
3148 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
3149 e = svm_msg_q_msg_data (mq, msg);
3150 if (*num_ev < maxevents)
3151 vcl_epoll_wait_handle_mq_event (wrk, e, events, num_ev);
3153 vcl_handle_mq_event (wrk, e);
3154 svm_msg_q_free_msg (mq, msg);
3156 vec_reset_length (wrk->mq_msg_vector);
3157 vcl_handle_pending_wrk_updates (wrk);
3162 vppcom_epoll_wait_condvar (vcl_worker_t *wrk, struct epoll_event *events,
3163 int maxevents, u32 n_evts, double timeout_ms)
3170 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3175 vcl_epoll_wait_handle_mq (wrk, wrk->app_event_queue, events, maxevents,
3176 timeout_ms, &n_evts);
3177 if (n_evts || !timeout_ms)
3180 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3186 vppcom_epoll_wait_eventfd (vcl_worker_t *wrk, struct epoll_event *events,
3187 int maxevents, u32 n_evts, double timeout_ms)
3189 int __clib_unused n_read;
3190 vcl_mq_evt_conn_t *mqc;
3195 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
3199 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3204 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
3205 vec_len (wrk->mq_events), timeout_ms);
3208 VDBG (0, "epoll_wait error %u", errno);
3212 for (i = 0; i < n_mq_evts; i++)
3214 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
3215 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
3216 vcl_epoll_wait_handle_mq (wrk, mqc->mq, events, maxevents, 0,
3220 if (n_evts || !timeout_ms)
3223 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3229 vcl_epoll_wait_handle_lt (vcl_worker_t *wrk, struct epoll_event *events,
3230 int maxevents, u32 *n_evts)
3232 u32 add_event = 0, next;
3237 ASSERT (wrk->ep_lt_current != VCL_INVALID_SESSION_INDEX);
3238 if (*n_evts >= maxevents)
3241 next = wrk->ep_lt_current;
3244 s = vcl_session_get (wrk, next);
3245 next = s->vep.lt_next;
3247 if ((s->vep.ev.events & EPOLLIN) && (rv = vcl_session_read_ready (s)))
3250 events[*n_evts].events |= rv > 0 ? EPOLLIN : EPOLLHUP | EPOLLRDHUP;
3251 evt_data = s->vep.ev.data.u64;
3253 if ((s->vep.ev.events & EPOLLOUT) && (rv = vcl_session_write_ready (s)))
3256 events[*n_evts].events |= rv > 0 ? EPOLLOUT : EPOLLHUP | EPOLLRDHUP;
3257 evt_data = s->vep.ev.data.u64;
3259 if (!add_event && s->session_state > VCL_STATE_READY)
3262 events[*n_evts].events |= EPOLLHUP | EPOLLRDHUP;
3263 evt_data = s->vep.ev.data.u64;
3267 events[*n_evts].data.u64 = evt_data;
3270 if (EPOLLONESHOT & s->vep.ev.events)
3271 s->vep.ev.events = 0;
3272 if (*n_evts == maxevents)
3274 wrk->ep_lt_current = next;
3280 vcl_epoll_lt_del (wrk, s);
3281 if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX)
3285 while (next != wrk->ep_lt_current);
3289 vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
3290 int maxevents, double wait_for_time)
3292 vcl_worker_t *wrk = vcl_worker_get_current ();
3293 vcl_session_t *vep_session;
3297 if (PREDICT_FALSE (maxevents <= 0))
3299 VDBG (0, "ERROR: Invalid maxevents (%d)!", maxevents);
3300 return VPPCOM_EINVAL;
3303 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
3305 return VPPCOM_EBADFD;
3307 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
3309 VDBG (0, "ERROR: vep_idx (%u) is not a vep!", vep_handle);
3310 return VPPCOM_EINVAL;
3313 if (vec_len (wrk->unhandled_evts_vector))
3315 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
3317 vcl_epoll_wait_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i],
3319 if (n_evts == maxevents)
3321 vec_delete (wrk->unhandled_evts_vector, i + 1, 0);
3325 vec_reset_length (wrk->unhandled_evts_vector);
3328 if (PREDICT_FALSE (wrk->ep_lt_current != VCL_INVALID_SESSION_INDEX))
3329 vcl_epoll_wait_handle_lt (wrk, events, maxevents, &n_evts);
3331 /* Request to only drain unhandled */
3332 if ((int) wait_for_time == -2)
3336 if (vcm->cfg.use_mq_eventfd)
3337 n_evts = vppcom_epoll_wait_eventfd (wrk, events, maxevents, n_evts,
3340 n_evts = vppcom_epoll_wait_condvar (wrk, events, maxevents, n_evts,
3347 vppcom_session_attr (uint32_t session_handle, uint32_t op,
3348 void *buffer, uint32_t * buflen)
3350 vcl_worker_t *wrk = vcl_worker_get_current ();
3351 u32 *flags = buffer;
3352 vppcom_endpt_t *ep = buffer;
3353 transport_endpt_attr_t tea;
3354 vcl_session_t *session;
3357 session = vcl_session_get_w_handle (wrk, session_handle);
3359 return VPPCOM_EBADFD;
3363 case VPPCOM_ATTR_GET_NREAD:
3364 rv = vcl_session_read_ready (session);
3365 VDBG (2, "VPPCOM_ATTR_GET_NREAD: sh %u, nread = %d", session_handle,
3369 case VPPCOM_ATTR_GET_NWRITE:
3370 rv = vcl_session_write_ready (session);
3371 VDBG (2, "VPPCOM_ATTR_GET_NWRITE: sh %u, nwrite = %d", session_handle,
3375 case VPPCOM_ATTR_GET_FLAGS:
3376 if (PREDICT_TRUE (buffer && buflen && (*buflen >= sizeof (*flags))))
3380 (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK) ?
3382 *buflen = sizeof (*flags);
3383 VDBG (2, "VPPCOM_ATTR_GET_FLAGS: sh %u, flags = 0x%08x, "
3384 "is_nonblocking = %u", session_handle, *flags,
3385 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3391 case VPPCOM_ATTR_SET_FLAGS:
3392 if (PREDICT_TRUE (buffer && buflen && (*buflen == sizeof (*flags))))
3394 if (*flags & O_NONBLOCK)
3395 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
3397 vcl_session_clear_attr (session, VCL_SESS_ATTR_NONBLOCK);
3399 VDBG (2, "VPPCOM_ATTR_SET_FLAGS: sh %u, flags = 0x%08x,"
3400 " is_nonblocking = %u", session_handle, *flags,
3401 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3407 case VPPCOM_ATTR_GET_PEER_ADDR:
3408 if (PREDICT_TRUE (buffer && buflen &&
3409 (*buflen >= sizeof (*ep)) && ep->ip))
3411 ep->is_ip4 = session->transport.is_ip4;
3412 ep->port = session->transport.rmt_port;
3413 if (session->transport.is_ip4)
3414 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
3415 sizeof (ip4_address_t));
3417 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
3418 sizeof (ip6_address_t));
3419 *buflen = sizeof (*ep);
3421 "VPPCOM_ATTR_GET_PEER_ADDR: sh %u, is_ip4 = %u, "
3422 "addr = %U, port %u",
3423 session_handle, ep->is_ip4, vcl_format_ip46_address,
3424 &session->transport.rmt_ip,
3425 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3426 clib_net_to_host_u16 (ep->port));
3432 case VPPCOM_ATTR_GET_LCL_ADDR:
3433 if (PREDICT_TRUE (buffer && buflen &&
3434 (*buflen >= sizeof (*ep)) && ep->ip))
3436 ep->is_ip4 = session->transport.is_ip4;
3437 ep->port = session->transport.lcl_port;
3438 if (session->transport.is_ip4)
3439 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip4,
3440 sizeof (ip4_address_t));
3442 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip6,
3443 sizeof (ip6_address_t));
3444 *buflen = sizeof (*ep);
3446 "VPPCOM_ATTR_GET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3448 session_handle, ep->is_ip4, vcl_format_ip46_address,
3449 &session->transport.lcl_ip,
3450 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3451 clib_net_to_host_u16 (ep->port));
3457 case VPPCOM_ATTR_SET_LCL_ADDR:
3458 if (PREDICT_TRUE (buffer && buflen &&
3459 (*buflen >= sizeof (*ep)) && ep->ip))
3461 session->transport.is_ip4 = ep->is_ip4;
3462 session->transport.lcl_port = ep->port;
3463 vcl_ip_copy_from_ep (&session->transport.lcl_ip, ep);
3464 *buflen = sizeof (*ep);
3466 "VPPCOM_ATTR_SET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3468 session_handle, ep->is_ip4, vcl_format_ip46_address,
3469 &session->transport.lcl_ip,
3470 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3471 clib_net_to_host_u16 (ep->port));
3477 case VPPCOM_ATTR_GET_LIBC_EPFD:
3478 rv = session->libc_epfd;
3479 VDBG (2, "VPPCOM_ATTR_GET_LIBC_EPFD: libc_epfd %d", rv);
3482 case VPPCOM_ATTR_SET_LIBC_EPFD:
3483 if (PREDICT_TRUE (buffer && buflen &&
3484 (*buflen == sizeof (session->libc_epfd))))
3486 session->libc_epfd = *(int *) buffer;
3487 *buflen = sizeof (session->libc_epfd);
3489 VDBG (2, "VPPCOM_ATTR_SET_LIBC_EPFD: libc_epfd %d, buflen %d",
3490 session->libc_epfd, *buflen);
3496 case VPPCOM_ATTR_GET_PROTOCOL:
3497 if (buffer && buflen && (*buflen >= sizeof (int)))
3499 *(int *) buffer = session->session_type;
3500 *buflen = sizeof (int);
3502 VDBG (2, "VPPCOM_ATTR_GET_PROTOCOL: %d (%s), buflen %d",
3503 *(int *) buffer, *(int *) buffer ? "UDP" : "TCP", *buflen);
3509 case VPPCOM_ATTR_GET_LISTEN:
3510 if (buffer && buflen && (*buflen >= sizeof (int)))
3512 *(int *) buffer = vcl_session_has_attr (session,
3513 VCL_SESS_ATTR_LISTEN);
3514 *buflen = sizeof (int);
3516 VDBG (2, "VPPCOM_ATTR_GET_LISTEN: %d, buflen %d", *(int *) buffer,
3523 case VPPCOM_ATTR_GET_ERROR:
3524 if (buffer && buflen && (*buflen >= sizeof (int)))
3526 *(int *) buffer = 0;
3527 *buflen = sizeof (int);
3529 VDBG (2, "VPPCOM_ATTR_GET_ERROR: %d, buflen %d, #VPP-TBD#",
3530 *(int *) buffer, *buflen);
3536 case VPPCOM_ATTR_GET_TX_FIFO_LEN:
3537 if (buffer && buflen && (*buflen >= sizeof (u32)))
3541 *(size_t *) buffer = (session->sndbuf_size ? session->sndbuf_size :
3543 svm_fifo_size (session->tx_fifo) :
3544 vcm->cfg.tx_fifo_size);
3545 *buflen = sizeof (u32);
3547 VDBG (2, "VPPCOM_ATTR_GET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3548 " #VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer,
3555 case VPPCOM_ATTR_SET_DSCP:
3556 if (buffer && buflen && (*buflen >= sizeof (u8)))
3558 session->dscp = *(u8 *) buffer;
3560 VDBG (2, "VPPCOM_ATTR_SET_DSCP: %u (0x%x), buflen %d,",
3561 *(u8 *) buffer, *(u8 *) buffer, *buflen);
3567 case VPPCOM_ATTR_SET_TX_FIFO_LEN:
3568 if (buffer && buflen && (*buflen == sizeof (u32)))
3571 session->sndbuf_size = *(u32 *) buffer;
3572 VDBG (2, "VPPCOM_ATTR_SET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3573 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3580 case VPPCOM_ATTR_GET_RX_FIFO_LEN:
3581 if (buffer && buflen && (*buflen >= sizeof (u32)))
3585 *(size_t *) buffer = (session->rcvbuf_size ? session->rcvbuf_size :
3587 svm_fifo_size (session->rx_fifo) :
3588 vcm->cfg.rx_fifo_size);
3589 *buflen = sizeof (u32);
3591 VDBG (2, "VPPCOM_ATTR_GET_RX_FIFO_LEN: %u (0x%x), buflen %d, "
3592 "#VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer, *buflen);
3598 case VPPCOM_ATTR_SET_RX_FIFO_LEN:
3599 if (buffer && buflen && (*buflen == sizeof (u32)))
3602 session->rcvbuf_size = *(u32 *) buffer;
3603 VDBG (2, "VPPCOM_ATTR_SET_RX_FIFO_LEN: %u (0x%x), buflen %d,"
3604 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3611 case VPPCOM_ATTR_GET_REUSEADDR:
3612 if (buffer && buflen && (*buflen >= sizeof (int)))
3615 *(int *) buffer = vcl_session_has_attr (session,
3616 VCL_SESS_ATTR_REUSEADDR);
3617 *buflen = sizeof (int);
3619 VDBG (2, "VPPCOM_ATTR_GET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3620 *(int *) buffer, *buflen);
3626 case VPPCOM_ATTR_SET_REUSEADDR:
3627 if (buffer && buflen && (*buflen == sizeof (int)) &&
3628 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3631 if (*(int *) buffer)
3632 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEADDR);
3634 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEADDR);
3636 VDBG (2, "VPPCOM_ATTR_SET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3637 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEADDR),
3644 case VPPCOM_ATTR_GET_REUSEPORT:
3645 if (buffer && buflen && (*buflen >= sizeof (int)))
3648 *(int *) buffer = vcl_session_has_attr (session,
3649 VCL_SESS_ATTR_REUSEPORT);
3650 *buflen = sizeof (int);
3652 VDBG (2, "VPPCOM_ATTR_GET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3653 *(int *) buffer, *buflen);
3659 case VPPCOM_ATTR_SET_REUSEPORT:
3660 if (buffer && buflen && (*buflen == sizeof (int)) &&
3661 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3664 if (*(int *) buffer)
3665 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEPORT);
3667 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEPORT);
3669 VDBG (2, "VPPCOM_ATTR_SET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3670 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEPORT),
3677 case VPPCOM_ATTR_GET_BROADCAST:
3678 if (buffer && buflen && (*buflen >= sizeof (int)))
3681 *(int *) buffer = vcl_session_has_attr (session,
3682 VCL_SESS_ATTR_BROADCAST);
3683 *buflen = sizeof (int);
3685 VDBG (2, "VPPCOM_ATTR_GET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3686 *(int *) buffer, *buflen);
3692 case VPPCOM_ATTR_SET_BROADCAST:
3693 if (buffer && buflen && (*buflen == sizeof (int)))
3696 if (*(int *) buffer)
3697 vcl_session_set_attr (session, VCL_SESS_ATTR_BROADCAST);
3699 vcl_session_clear_attr (session, VCL_SESS_ATTR_BROADCAST);
3701 VDBG (2, "VPPCOM_ATTR_SET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3702 vcl_session_has_attr (session, VCL_SESS_ATTR_BROADCAST),
3709 case VPPCOM_ATTR_GET_V6ONLY:
3710 if (buffer && buflen && (*buflen >= sizeof (int)))
3713 *(int *) buffer = vcl_session_has_attr (session,
3714 VCL_SESS_ATTR_V6ONLY);
3715 *buflen = sizeof (int);
3717 VDBG (2, "VPPCOM_ATTR_GET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3718 *(int *) buffer, *buflen);
3724 case VPPCOM_ATTR_SET_V6ONLY:
3725 if (buffer && buflen && (*buflen == sizeof (int)))
3728 if (*(int *) buffer)
3729 vcl_session_set_attr (session, VCL_SESS_ATTR_V6ONLY);
3731 vcl_session_clear_attr (session, VCL_SESS_ATTR_V6ONLY);
3733 VDBG (2, "VPPCOM_ATTR_SET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3734 vcl_session_has_attr (session, VCL_SESS_ATTR_V6ONLY),
3741 case VPPCOM_ATTR_GET_KEEPALIVE:
3742 if (buffer && buflen && (*buflen >= sizeof (int)))
3745 *(int *) buffer = vcl_session_has_attr (session,
3746 VCL_SESS_ATTR_KEEPALIVE);
3747 *buflen = sizeof (int);
3749 VDBG (2, "VPPCOM_ATTR_GET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3750 *(int *) buffer, *buflen);
3756 case VPPCOM_ATTR_SET_KEEPALIVE:
3757 if (buffer && buflen && (*buflen == sizeof (int)))
3760 if (*(int *) buffer)
3761 vcl_session_set_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3763 vcl_session_clear_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3765 VDBG (2, "VPPCOM_ATTR_SET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3766 vcl_session_has_attr (session, VCL_SESS_ATTR_KEEPALIVE),
3773 case VPPCOM_ATTR_GET_TCP_NODELAY:
3774 if (buffer && buflen && (*buflen >= sizeof (int)))
3777 *(int *) buffer = vcl_session_has_attr (session,
3778 VCL_SESS_ATTR_TCP_NODELAY);
3779 *buflen = sizeof (int);
3781 VDBG (2, "VPPCOM_ATTR_GET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3782 *(int *) buffer, *buflen);
3788 case VPPCOM_ATTR_SET_TCP_NODELAY:
3789 if (buffer && buflen && (*buflen == sizeof (int)))
3792 if (*(int *) buffer)
3793 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3795 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3797 VDBG (2, "VPPCOM_ATTR_SET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3798 vcl_session_has_attr (session, VCL_SESS_ATTR_TCP_NODELAY),
3805 case VPPCOM_ATTR_GET_TCP_KEEPIDLE:
3806 if (buffer && buflen && (*buflen >= sizeof (int)))
3809 *(int *) buffer = vcl_session_has_attr (session,
3810 VCL_SESS_ATTR_TCP_KEEPIDLE);
3811 *buflen = sizeof (int);
3813 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3814 *(int *) buffer, *buflen);
3820 case VPPCOM_ATTR_SET_TCP_KEEPIDLE:
3821 if (buffer && buflen && (*buflen == sizeof (int)))
3824 if (*(int *) buffer)
3825 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3827 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3829 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3830 vcl_session_has_attr (session,
3831 VCL_SESS_ATTR_TCP_KEEPIDLE), *buflen);
3837 case VPPCOM_ATTR_GET_TCP_KEEPINTVL:
3838 if (buffer && buflen && (*buflen >= sizeof (int)))
3841 *(int *) buffer = vcl_session_has_attr (session,
3842 VCL_SESS_ATTR_TCP_KEEPINTVL);
3843 *buflen = sizeof (int);
3845 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3846 *(int *) buffer, *buflen);
3852 case VPPCOM_ATTR_SET_TCP_KEEPINTVL:
3853 if (buffer && buflen && (*buflen == sizeof (int)))
3856 if (*(int *) buffer)
3857 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3859 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3861 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3862 vcl_session_has_attr (session,
3863 VCL_SESS_ATTR_TCP_KEEPINTVL), *buflen);
3869 case VPPCOM_ATTR_GET_TCP_USER_MSS:
3870 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
3876 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3877 tea.mss = *(u32 *) buffer;
3878 if (vcl_session_transport_attr (wrk, session, 1 /* is_get */, &tea))
3879 rv = VPPCOM_ENOPROTOOPT;
3883 *(u32 *) buffer = tea.mss;
3884 *buflen = sizeof (int);
3887 VDBG (2, "VPPCOM_ATTR_GET_TCP_USER_MSS: %d, buflen %d", *(int *) buffer,
3891 case VPPCOM_ATTR_SET_TCP_USER_MSS:
3892 if (!(buffer && buflen && (*buflen == sizeof (u32))))
3898 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3899 tea.mss = *(u32 *) buffer;
3900 if (vcl_session_transport_attr (wrk, session, 0 /* is_get */, &tea))
3901 rv = VPPCOM_ENOPROTOOPT;
3903 VDBG (2, "VPPCOM_ATTR_SET_TCP_USER_MSS: %u, buflen %d", tea.mss,
3907 case VPPCOM_ATTR_SET_CONNECTED:
3908 session->flags |= VCL_SESSION_F_CONNECTED;
3911 case VPPCOM_ATTR_SET_CKPAIR:
3912 if (!(buffer && buflen && (*buflen == sizeof (int))) ||
3913 !vcl_session_has_crypto (session))
3918 if (!session->ext_config)
3920 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_CRYPTO,
3921 sizeof (transport_endpt_ext_cfg_t));
3923 else if (session->ext_config->type != TRANSPORT_ENDPT_EXT_CFG_CRYPTO)
3929 session->ext_config->crypto.ckpair_index = *(uint32_t *) buffer;
3932 case VPPCOM_ATTR_SET_VRF:
3933 if (!(buffer && buflen && (*buflen == sizeof (u32))))
3938 session->vrf = *(u32 *) buffer;
3941 case VPPCOM_ATTR_GET_VRF:
3942 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
3947 *(u32 *) buffer = session->vrf;
3948 *buflen = sizeof (u32);
3951 case VPPCOM_ATTR_GET_DOMAIN:
3952 if (!(buffer && buflen && (*buflen >= sizeof (int))))
3958 if (session->transport.is_ip4)
3959 *(int *) buffer = AF_INET;
3961 *(int *) buffer = AF_INET6;
3962 *buflen = sizeof (int);
3964 VDBG (2, "VPPCOM_ATTR_GET_DOMAIN: %d, buflen %u", *(int *) buffer,
3968 case VPPCOM_ATTR_SET_ENDPT_EXT_CFG:
3969 if (!(buffer && buflen && (*buflen > 0)))
3974 if (session->ext_config)
3979 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_NONE,
3980 *buflen + sizeof (u32));
3981 clib_memcpy (session->ext_config->data, buffer, *buflen);
3982 session->ext_config->len = *buflen;
3994 vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
3995 uint32_t buflen, int flags, vppcom_endpt_t * ep)
3997 vcl_worker_t *wrk = vcl_worker_get_current ();
3998 vcl_session_t *session;
4002 rv = vppcom_session_read (session_handle, buffer, buflen);
4003 else if (flags & MSG_PEEK)
4004 rv = vppcom_session_peek (session_handle, buffer, buflen);
4007 VDBG (0, "Unsupport flags for recvfrom %d", flags);
4008 return VPPCOM_EAFNOSUPPORT;
4013 session = vcl_session_get_w_handle (wrk, session_handle);
4014 if (session->transport.is_ip4)
4015 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
4016 sizeof (ip4_address_t));
4018 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
4019 sizeof (ip6_address_t));
4020 ep->is_ip4 = session->transport.is_ip4;
4021 ep->port = session->transport.rmt_port;
4028 vppcom_session_sendto (uint32_t session_handle, void *buffer,
4029 uint32_t buflen, int flags, vppcom_endpt_t * ep)
4031 vcl_worker_t *wrk = vcl_worker_get_current ();
4034 s = vcl_session_get_w_handle (wrk, session_handle);
4035 if (PREDICT_FALSE (!s))
4036 return VPPCOM_EBADFD;
4040 if (!vcl_session_is_cl (s))
4041 return VPPCOM_EINVAL;
4043 s->transport.is_ip4 = ep->is_ip4;
4044 s->transport.rmt_port = ep->port;
4045 vcl_ip_copy_from_ep (&s->transport.rmt_ip, ep);
4047 /* Session not connected/bound in vpp. Create it by 'connecting' it */
4048 if (PREDICT_FALSE (s->session_state == VCL_STATE_CLOSED))
4050 u32 session_index = s->session_index;
4051 f64 timeout = vcm->cfg.session_timeout;
4054 vcl_send_session_connect (wrk, s);
4055 rv = vppcom_wait_for_session_state_change (session_index,
4060 s = vcl_session_get (wrk, session_index);
4066 // TBD check the flags and do the right thing
4067 VDBG (2, "handling flags 0x%u (%d) not implemented yet.", flags, flags);
4070 return (vppcom_session_write_inline (wrk, s, buffer, buflen, 1,
4071 s->is_dgram ? 1 : 0));
4075 vppcom_poll (vcl_poll_t * vp, uint32_t n_sids, double wait_for_time)
4077 vcl_worker_t *wrk = vcl_worker_get_current ();
4078 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
4079 u32 i, keep_trying = 1;
4080 svm_msg_q_msg_t msg;
4084 VDBG (3, "vp %p, nsids %u, wait_for_time %f", vp, n_sids, wait_for_time);
4087 return VPPCOM_EFAULT;
4091 vcl_session_t *session;
4093 /* Dequeue all events and drop all unhandled io events */
4094 while (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0) == 0)
4096 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
4097 vcl_handle_mq_event (wrk, e);
4098 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
4100 vec_reset_length (wrk->unhandled_evts_vector);
4102 for (i = 0; i < n_sids; i++)
4104 session = vcl_session_get (wrk, vp[i].sh);
4107 vp[i].revents = POLLHUP;
4114 if (POLLIN & vp[i].events)
4116 rv = vcl_session_read_ready (session);
4119 vp[i].revents |= POLLIN;
4126 case VPPCOM_ECONNRESET:
4127 vp[i].revents = POLLHUP;
4131 vp[i].revents = POLLERR;
4138 if (POLLOUT & vp[i].events)
4140 rv = vcl_session_write_ready (session);
4143 vp[i].revents |= POLLOUT;
4150 case VPPCOM_ECONNRESET:
4151 vp[i].revents = POLLHUP;
4155 vp[i].revents = POLLERR;
4162 if (0) // Note "done:" label used by VCL_SESSION_LOCK_AND_GET()
4164 vp[i].revents = POLLNVAL;
4168 if (wait_for_time != -1)
4169 keep_trying = (clib_time_now (&wrk->clib_time) <= timeout) ? 1 : 0;
4171 while ((num_ev == 0) && keep_trying);
4177 vppcom_mq_epoll_fd (void)
4179 vcl_worker_t *wrk = vcl_worker_get_current ();
4180 return wrk->mqs_epfd;
4184 vppcom_session_index (vcl_session_handle_t session_handle)
4186 return session_handle & 0xFFFFFF;
4190 vppcom_session_worker (vcl_session_handle_t session_handle)
4192 return session_handle >> 24;
4196 vppcom_worker_register (void)
4198 if (!vcl_worker_alloc_and_init ())
4199 return VPPCOM_EEXIST;
4201 if (vcl_worker_register_with_vpp ())
4202 return VPPCOM_EEXIST;
4208 vppcom_worker_unregister (void)
4210 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
4211 vcl_set_worker_index (~0);
4215 vppcom_worker_index_set (int index)
4217 vcl_set_worker_index (index);
4221 vppcom_worker_index (void)
4223 return vcl_get_worker_index ();
4227 vppcom_worker_mqs_epfd (void)
4229 vcl_worker_t *wrk = vcl_worker_get_current ();
4230 if (!vcm->cfg.use_mq_eventfd)
4232 return wrk->mqs_epfd;
4236 vppcom_session_is_connectable_listener (uint32_t session_handle)
4238 vcl_session_t *session;
4239 vcl_worker_t *wrk = vcl_worker_get_current ();
4240 session = vcl_session_get_w_handle (wrk, session_handle);
4242 return VPPCOM_EBADFD;
4243 return vcl_session_is_connectable_listener (wrk, session);
4247 vppcom_session_listener (uint32_t session_handle)
4249 vcl_worker_t *wrk = vcl_worker_get_current ();
4250 vcl_session_t *listen_session, *session;
4251 session = vcl_session_get_w_handle (wrk, session_handle);
4253 return VPPCOM_EBADFD;
4254 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
4255 return VPPCOM_EBADFD;
4256 listen_session = vcl_session_get_w_handle (wrk, session->listener_index);
4257 if (!listen_session)
4258 return VPPCOM_EBADFD;
4259 return vcl_session_handle (listen_session);
4263 vppcom_session_n_accepted (uint32_t session_handle)
4265 vcl_worker_t *wrk = vcl_worker_get_current ();
4266 vcl_session_t *session = vcl_session_get_w_handle (wrk, session_handle);
4268 return VPPCOM_EBADFD;
4269 return session->n_accepted_sessions;
4273 vppcom_proto_str (vppcom_proto_t proto)
4275 char const *proto_str;
4279 case VPPCOM_PROTO_TCP:
4282 case VPPCOM_PROTO_UDP:
4285 case VPPCOM_PROTO_TLS:
4288 case VPPCOM_PROTO_QUIC:
4291 case VPPCOM_PROTO_DTLS:
4294 case VPPCOM_PROTO_SRTP:
4298 proto_str = "UNKNOWN";
4305 vppcom_retval_str (int retval)
4316 st = "VPPCOM_EAGAIN";
4320 st = "VPPCOM_EFAULT";
4324 st = "VPPCOM_ENOMEM";
4328 st = "VPPCOM_EINVAL";
4332 st = "VPPCOM_EBADFD";
4335 case VPPCOM_EAFNOSUPPORT:
4336 st = "VPPCOM_EAFNOSUPPORT";
4339 case VPPCOM_ECONNABORTED:
4340 st = "VPPCOM_ECONNABORTED";
4343 case VPPCOM_ECONNRESET:
4344 st = "VPPCOM_ECONNRESET";
4347 case VPPCOM_ENOTCONN:
4348 st = "VPPCOM_ENOTCONN";
4351 case VPPCOM_ECONNREFUSED:
4352 st = "VPPCOM_ECONNREFUSED";
4355 case VPPCOM_ETIMEDOUT:
4356 st = "VPPCOM_ETIMEDOUT";
4360 st = "UNKNOWN_STATE";
4368 vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
4370 if (vcm->cfg.vpp_app_socket_api)
4371 return vcl_sapi_add_cert_key_pair (ckpair);
4373 return vcl_bapi_add_cert_key_pair (ckpair);
4377 vppcom_del_cert_key_pair (uint32_t ckpair_index)
4379 if (vcm->cfg.vpp_app_socket_api)
4380 return vcl_sapi_del_cert_key_pair (ckpair_index);
4382 return vcl_bapi_del_cert_key_pair (ckpair_index);
4386 * fd.io coding-style-patch-verification: ON
4389 * eval: (c-set-style "gnu")