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 VDBG (0, "ERROR: vpp handle 0x%llx has no session index (%u)!",
393 mp->handle, session_index);
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;
408 VDBG (0, "ERROR: session index %u: connect failed! %U",
409 session_index, format_session_error, mp->retval);
410 session->session_state = VCL_STATE_DETACHED;
411 session->vpp_handle = mp->handle;
412 return session_index;
415 session->vpp_handle = mp->handle;
417 if (vcl_segment_attach_session (
418 mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo,
419 mp->vpp_event_queue_address, mp->mq_index, 0, session))
421 VDBG (0, "failed to attach fifos for %u", session->session_index);
422 session->session_state = VCL_STATE_DETACHED;
423 vcl_send_session_disconnect (wrk, session);
424 return session_index;
429 if (vcl_segment_attach_session (mp->ct_segment_handle, mp->ct_rx_fifo,
430 mp->ct_tx_fifo, (uword) ~0, ~0, 1,
433 VDBG (0, "failed to attach ct fifos for %u", session->session_index);
434 session->session_state = VCL_STATE_DETACHED;
435 vcl_send_session_disconnect (wrk, session);
436 return session_index;
440 session->transport.is_ip4 = mp->lcl.is_ip4;
441 clib_memcpy_fast (&session->transport.lcl_ip, &mp->lcl.ip,
442 sizeof (session->transport.lcl_ip));
443 session->transport.lcl_port = mp->lcl.port;
445 /* Application closed session before connect reply */
446 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK)
447 && session->session_state == VCL_STATE_CLOSED)
448 vcl_send_session_disconnect (wrk, session);
450 session->session_state = VCL_STATE_READY;
452 /* Add it to lookup table */
453 vcl_session_table_add_vpp_handle (wrk, mp->handle, session_index);
455 VDBG (1, "session %u [0x%llx] connected! rx_fifo %p, refcnt %d, tx_fifo %p,"
456 " refcnt %d", session_index, mp->handle, session->rx_fifo,
457 session->rx_fifo->refcnt, session->tx_fifo, session->tx_fifo->refcnt);
459 return session_index;
463 vcl_flag_accepted_session (vcl_session_t * session, u64 handle, u32 flags)
465 vcl_session_msg_t *accepted_msg;
468 for (i = 0; i < vec_len (session->accept_evts_fifo); i++)
470 accepted_msg = &session->accept_evts_fifo[i];
471 if (accepted_msg->accepted_msg.handle == handle)
473 accepted_msg->flags |= flags;
481 vcl_session_reset_handler (vcl_worker_t * wrk,
482 session_reset_msg_t * reset_msg)
484 vcl_session_t *session;
487 sid = vcl_session_index_from_vpp_handle (wrk, reset_msg->handle);
488 session = vcl_session_get (wrk, sid);
491 VDBG (0, "request to reset unknown handle 0x%llx", reset_msg->handle);
492 return VCL_INVALID_SESSION_INDEX;
495 /* Caught a reset before actually accepting the session */
496 if (session->session_state == VCL_STATE_LISTEN)
499 if (!vcl_flag_accepted_session (session, reset_msg->handle,
500 VCL_ACCEPTED_F_RESET))
501 VDBG (0, "session was not accepted!");
502 return VCL_INVALID_SESSION_INDEX;
505 if (session->session_state != VCL_STATE_CLOSED)
506 session->session_state = VCL_STATE_DISCONNECT;
507 VDBG (0, "reset session %u [0x%llx]", sid, reset_msg->handle);
512 vcl_session_bound_handler (vcl_worker_t * wrk, session_bound_msg_t * mp)
514 vcl_session_t *session;
515 u32 sid = mp->context;
517 session = vcl_session_get (wrk, sid);
520 VERR ("session %u [0x%llx]: bind failed: %U", sid, mp->handle,
521 format_session_error, mp->retval);
524 session->session_state = VCL_STATE_DETACHED;
525 session->vpp_handle = mp->handle;
530 VDBG (0, "ERROR: session %u [0x%llx]: Invalid session index!",
532 return VCL_INVALID_SESSION_INDEX;
536 session->vpp_handle = mp->handle;
537 session->transport.is_ip4 = mp->lcl_is_ip4;
538 clib_memcpy_fast (&session->transport.lcl_ip, mp->lcl_ip,
539 sizeof (ip46_address_t));
540 session->transport.lcl_port = mp->lcl_port;
541 vcl_session_table_add_listener (wrk, mp->handle, sid);
542 session->session_state = VCL_STATE_LISTEN;
544 if (vcl_session_is_cl (session))
546 if (vcl_segment_attach_session (mp->segment_handle, mp->rx_fifo,
547 mp->tx_fifo, mp->vpp_evt_q, mp->mq_index,
550 VDBG (0, "failed to attach fifos for %u", session->session_index);
551 session->session_state = VCL_STATE_DETACHED;
552 return VCL_INVALID_SESSION_INDEX;
556 VDBG (0, "session %u [0x%llx]: listen succeeded!", sid, mp->handle);
561 vcl_session_unlisten_reply_handler (vcl_worker_t * wrk, void *data)
563 session_unlisten_reply_msg_t *mp = (session_unlisten_reply_msg_t *) data;
566 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
569 VDBG (0, "Unlisten reply with wrong handle %llx", mp->handle);
572 if (s->session_state != VCL_STATE_DISCONNECT)
574 /* Connected udp listener */
575 if (s->session_type == VPPCOM_PROTO_UDP
576 && s->session_state == VCL_STATE_CLOSED)
579 VDBG (0, "Unlisten session in wrong state %llx", mp->handle);
584 VDBG (0, "ERROR: session %u [0xllx]: unlisten failed: %U",
585 s->session_index, mp->handle, format_session_error, mp->retval);
587 if (mp->context != wrk->wrk_index)
588 VDBG (0, "wrong context");
590 vcl_session_table_del_vpp_handle (wrk, mp->handle);
591 vcl_session_free (wrk, s);
595 vcl_session_migrated_handler (vcl_worker_t * wrk, void *data)
597 session_migrated_msg_t *mp = (session_migrated_msg_t *) data;
601 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
604 VDBG (0, "Migrated notification with wrong handle %llx", mp->handle);
608 /* Only validate if a value is provided */
609 if (mp->segment_handle != SESSION_INVALID_HANDLE)
611 fs_index = vcl_segment_table_lookup (mp->segment_handle);
612 if (fs_index == VCL_INVALID_SEGMENT_INDEX)
614 VDBG (0, "segment %lx for session %u is not mounted!",
615 mp->segment_handle, s->session_index);
616 s->session_state = VCL_STATE_DETACHED;
621 s->vpp_handle = mp->new_handle;
623 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0), mp->vpp_evt_q,
624 mp->vpp_thread_index, &s->vpp_evt_q);
626 vcl_session_table_del_vpp_handle (wrk, mp->handle);
627 vcl_session_table_add_vpp_handle (wrk, mp->new_handle, s->session_index);
629 /* Generate new tx event if we have outstanding data */
630 if (svm_fifo_has_event (s->tx_fifo))
631 app_send_io_evt_to_vpp (s->vpp_evt_q,
632 s->tx_fifo->shr->master_session_index,
633 SESSION_IO_EVT_TX, SVM_Q_WAIT);
635 VDBG (0, "Migrated 0x%lx to thread %u 0x%lx", mp->handle,
636 mp->vpp_thread_index, mp->new_handle);
639 static vcl_session_t *
640 vcl_session_accepted (vcl_worker_t * wrk, session_accepted_msg_t * msg)
642 vcl_session_msg_t *vcl_msg;
643 vcl_session_t *session;
645 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
646 if (PREDICT_FALSE (session != 0))
647 VWRN ("session overlap handle %lu state %u!", msg->handle,
648 session->session_state);
650 session = vcl_session_table_lookup_listener (wrk, msg->listener_handle);
653 VERR ("couldn't find listen session: listener handle %llx",
654 msg->listener_handle);
658 clib_fifo_add2 (session->accept_evts_fifo, vcl_msg);
660 vcl_msg->accepted_msg = *msg;
661 /* Session handle points to listener until fully accepted by app */
662 vcl_session_table_add_vpp_handle (wrk, msg->handle, session->session_index);
667 static vcl_session_t *
668 vcl_session_disconnected_handler (vcl_worker_t * wrk,
669 session_disconnected_msg_t * msg)
671 vcl_session_t *session;
673 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
676 VDBG (0, "request to disconnect unknown handle 0x%llx", msg->handle);
680 /* Late disconnect notification on a session that has been closed */
681 if (session->session_state == VCL_STATE_CLOSED)
684 /* Caught a disconnect before actually accepting the session */
685 if (session->session_state == VCL_STATE_LISTEN)
687 if (!vcl_flag_accepted_session (session, msg->handle,
688 VCL_ACCEPTED_F_CLOSED))
689 VDBG (0, "session was not accepted!");
693 /* If not already reset change state */
694 if (session->session_state != VCL_STATE_DISCONNECT)
695 session->session_state = VCL_STATE_VPP_CLOSING;
701 vppcom_session_shutdown (uint32_t session_handle, int how)
703 vcl_worker_t *wrk = vcl_worker_get_current ();
704 vcl_session_t *session;
705 vcl_session_state_t state;
708 session = vcl_session_get_w_handle (wrk, session_handle);
709 if (PREDICT_FALSE (!session))
710 return VPPCOM_EBADFD;
712 vpp_handle = session->vpp_handle;
713 state = session->session_state;
715 VDBG (1, "session %u [0x%llx] state 0x%x (%s)", session->session_index,
716 vpp_handle, state, vcl_session_state_str (state));
718 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
720 VDBG (0, "ERROR: Cannot shutdown a listen socket!");
721 return VPPCOM_EBADFD;
724 if (how == SHUT_RD || how == SHUT_RDWR)
726 session->flags |= VCL_SESSION_F_RD_SHUTDOWN;
730 session->flags |= VCL_SESSION_F_WR_SHUTDOWN;
732 if (PREDICT_TRUE (state == VCL_STATE_READY))
734 VDBG (1, "session %u [0x%llx]: sending shutdown...",
735 session->session_index, vpp_handle);
737 vcl_send_session_shutdown (wrk, session);
744 vppcom_session_disconnect (u32 session_handle)
746 vcl_worker_t *wrk = vcl_worker_get_current ();
747 vcl_session_t *session, *listen_session;
748 vcl_session_state_t state;
751 session = vcl_session_get_w_handle (wrk, session_handle);
753 return VPPCOM_EBADFD;
755 vpp_handle = session->vpp_handle;
756 state = session->session_state;
758 VDBG (1, "session %u [0x%llx] state 0x%x (%s)", session->session_index,
759 vpp_handle, state, vcl_session_state_str (state));
761 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
763 VDBG (0, "ERROR: Cannot disconnect a listen socket!");
764 return VPPCOM_EBADFD;
767 if (state == VCL_STATE_VPP_CLOSING)
769 vcl_send_session_disconnected_reply (wrk, session, 0);
770 VDBG (1, "session %u [0x%llx]: sending disconnect REPLY...",
771 session->session_index, vpp_handle);
775 /* Session doesn't have an event queue yet. Probably a non-blocking
776 * connect. Wait for the reply */
777 if (PREDICT_FALSE (!session->vpp_evt_q))
780 VDBG (1, "session %u [0x%llx]: sending disconnect...",
781 session->session_index, vpp_handle);
782 vcl_send_session_disconnect (wrk, session);
785 if (session->listener_index != VCL_INVALID_SESSION_INDEX)
787 listen_session = vcl_session_get (wrk, session->listener_index);
788 listen_session->n_accepted_sessions--;
795 vcl_session_cleanup_handler (vcl_worker_t * wrk, void *data)
797 session_cleanup_msg_t *msg;
798 vcl_session_t *session;
800 msg = (session_cleanup_msg_t *) data;
801 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
804 VDBG (0, "disconnect confirmed for unknown handle 0x%llx", msg->handle);
808 if (msg->type == SESSION_CLEANUP_TRANSPORT)
810 /* Transport was cleaned up before we confirmed close. Probably the
811 * app is still waiting for some data that cannot be delivered.
812 * Confirm close to make sure everything is cleaned up.
813 * Move to undetermined state to ensure that the session is not
814 * removed before both vpp and the app cleanup.
815 * - If the app closes first, the session is moved to CLOSED state
816 * and the session cleanup notification from vpp removes the
818 * - If vpp cleans up the session first, the session is moved to
819 * DETACHED state lower and subsequently the close from the app
822 if (session->session_state == VCL_STATE_VPP_CLOSING)
824 vppcom_session_disconnect (vcl_session_handle (session));
825 session->session_state = VCL_STATE_UPDATED;
827 else if (session->session_state == VCL_STATE_DISCONNECT)
829 vcl_send_session_reset_reply (wrk, session, 0);
830 session->session_state = VCL_STATE_UPDATED;
835 vcl_session_table_del_vpp_handle (wrk, msg->handle);
836 /* Should not happen. App did not close the connection so don't free it. */
837 if (session->session_state != VCL_STATE_CLOSED)
839 VDBG (0, "app did not close session %d", session->session_index);
840 session->session_state = VCL_STATE_DETACHED;
841 session->vpp_handle = VCL_INVALID_SESSION_HANDLE;
844 vcl_session_free (wrk, session);
848 vcl_session_req_worker_update_handler (vcl_worker_t * wrk, void *data)
850 session_req_worker_update_msg_t *msg;
853 msg = (session_req_worker_update_msg_t *) data;
854 s = vcl_session_get_w_vpp_handle (wrk, msg->session_handle);
858 vec_add1 (wrk->pending_session_wrk_updates, s->session_index);
862 vcl_session_worker_update_reply_handler (vcl_worker_t * wrk, void *data)
864 session_worker_update_reply_msg_t *msg;
867 msg = (session_worker_update_reply_msg_t *) data;
868 s = vcl_session_get_w_vpp_handle (wrk, msg->handle);
871 VDBG (0, "unknown handle 0x%llx", msg->handle);
877 if (vcl_segment_attach_session (msg->segment_handle, msg->rx_fifo,
878 msg->tx_fifo, (uword) ~0, ~0, 0, s))
880 VDBG (0, "failed to attach fifos for %u", s->session_index);
884 s->session_state = VCL_STATE_UPDATED;
886 VDBG (0, "session %u[0x%llx] moved to worker %u", s->session_index,
887 s->vpp_handle, wrk->wrk_index);
891 vcl_api_recv_fd (vcl_worker_t * wrk, int *fds, int n_fds)
894 if (vcm->cfg.vpp_app_socket_api)
895 return vcl_sapi_recv_fds (wrk, fds, n_fds);
897 return vcl_bapi_recv_fds (wrk, fds, n_fds);
901 vcl_session_app_add_segment_handler (vcl_worker_t * wrk, void *data)
903 ssvm_segment_type_t seg_type = SSVM_SEGMENT_SHM;
904 session_app_add_segment_msg_t *msg;
908 msg = (session_app_add_segment_msg_t *) data;
912 vcl_api_recv_fd (wrk, &fd, 1);
913 seg_type = SSVM_SEGMENT_MEMFD;
916 segment_handle = msg->segment_handle;
917 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
919 clib_warning ("invalid segment handle");
923 if (vcl_segment_attach (segment_handle, (char *) msg->segment_name,
926 VDBG (0, "vcl_segment_attach ('%s') failed", msg->segment_name);
930 VDBG (1, "mapped new segment '%s' size %d", msg->segment_name,
935 vcl_session_app_del_segment_handler (vcl_worker_t * wrk, void *data)
937 session_app_del_segment_msg_t *msg = (session_app_del_segment_msg_t *) data;
938 vcl_segment_detach (msg->segment_handle);
939 VDBG (1, "Unmapped segment: %d", msg->segment_handle);
943 vcl_worker_rpc_handler (vcl_worker_t * wrk, void *data)
945 if (!vcm->wrk_rpc_fn)
948 (vcm->wrk_rpc_fn) (((session_app_wrk_rpc_msg_t *) data)->data);
952 vcl_session_transport_attr_reply_handler (vcl_worker_t *wrk, void *data)
954 session_transport_attr_reply_msg_t *mp;
956 if (!wrk->session_attr_op)
959 mp = (session_transport_attr_reply_msg_t *) data;
961 wrk->session_attr_op_rv = mp->retval;
962 wrk->session_attr_op = 0;
963 wrk->session_attr_rv = mp->attr;
967 vcl_handle_mq_event (vcl_worker_t * wrk, session_event_t * e)
969 session_disconnected_msg_t *disconnected_msg;
970 session_connected_msg_t *connected_msg;
971 session_reset_msg_t *reset_msg;
972 session_event_t *ecpy;
976 switch (e->event_type)
978 case SESSION_IO_EVT_RX:
979 case SESSION_IO_EVT_TX:
980 s = vcl_session_get (wrk, e->session_index);
981 if (!s || !vcl_session_is_open (s))
983 vec_add1 (wrk->unhandled_evts_vector, *e);
985 case SESSION_CTRL_EVT_BOUND:
986 /* We can only wait for only one listen so not postponed */
987 vcl_session_bound_handler (wrk, (session_bound_msg_t *) e->data);
989 case SESSION_CTRL_EVT_ACCEPTED:
990 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
991 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
993 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
996 ecpy->session_index = s->session_index;
999 case SESSION_CTRL_EVT_CONNECTED:
1000 connected_msg = (session_connected_msg_t *) e->data;
1001 sid = vcl_session_connected_handler (wrk, connected_msg);
1002 if (!(s = vcl_session_get (wrk, sid)))
1004 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1006 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1008 ecpy->postponed = 1;
1009 ecpy->session_index = s->session_index;
1012 case SESSION_CTRL_EVT_DISCONNECTED:
1013 disconnected_msg = (session_disconnected_msg_t *) e->data;
1014 if (!(s = vcl_session_get_w_vpp_handle (wrk, disconnected_msg->handle)))
1016 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1018 vec_add1 (wrk->unhandled_evts_vector, *e);
1021 if (!(s = vcl_session_disconnected_handler (wrk, disconnected_msg)))
1023 VDBG (0, "disconnected session %u [0x%llx]", s->session_index,
1026 case SESSION_CTRL_EVT_RESET:
1027 reset_msg = (session_reset_msg_t *) e->data;
1028 if (!(s = vcl_session_get_w_vpp_handle (wrk, reset_msg->handle)))
1030 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1032 vec_add1 (wrk->unhandled_evts_vector, *e);
1035 vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
1037 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
1038 vcl_session_unlisten_reply_handler (wrk, e->data);
1040 case SESSION_CTRL_EVT_MIGRATED:
1041 vcl_session_migrated_handler (wrk, e->data);
1043 case SESSION_CTRL_EVT_CLEANUP:
1044 vcl_session_cleanup_handler (wrk, e->data);
1046 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
1047 vcl_session_req_worker_update_handler (wrk, e->data);
1049 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
1050 vcl_session_worker_update_reply_handler (wrk, e->data);
1052 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
1053 vcl_session_app_add_segment_handler (wrk, e->data);
1055 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
1056 vcl_session_app_del_segment_handler (wrk, e->data);
1058 case SESSION_CTRL_EVT_APP_WRK_RPC:
1059 vcl_worker_rpc_handler (wrk, e->data);
1061 case SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY:
1062 vcl_session_transport_attr_reply_handler (wrk, e->data);
1065 clib_warning ("unhandled %u", e->event_type);
1071 vppcom_wait_for_session_state_change (u32 session_index,
1072 vcl_session_state_t state,
1075 vcl_worker_t *wrk = vcl_worker_get_current ();
1076 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
1077 vcl_session_t *volatile session;
1078 svm_msg_q_msg_t msg;
1083 session = vcl_session_get (wrk, session_index);
1084 if (PREDICT_FALSE (!session))
1086 return VPPCOM_EBADFD;
1088 if (session->session_state == state)
1092 if (session->session_state == VCL_STATE_DETACHED)
1094 return VPPCOM_ECONNREFUSED;
1097 if (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0))
1102 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
1103 vcl_handle_mq_event (wrk, e);
1104 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
1106 while (clib_time_now (&wrk->clib_time) < timeout);
1108 VDBG (0, "timeout waiting for state 0x%x (%s)", state,
1109 vcl_session_state_str (state));
1110 vcl_evt (VCL_EVT_SESSION_TIMEOUT, session, session_state);
1112 return VPPCOM_ETIMEDOUT;
1116 vcl_handle_pending_wrk_updates (vcl_worker_t * wrk)
1118 vcl_session_state_t state;
1122 if (PREDICT_TRUE (vec_len (wrk->pending_session_wrk_updates) == 0))
1125 vec_foreach (sip, wrk->pending_session_wrk_updates)
1127 s = vcl_session_get (wrk, *sip);
1128 vcl_send_session_worker_update (wrk, s, wrk->wrk_index);
1129 state = s->session_state;
1130 vppcom_wait_for_session_state_change (s->session_index, VCL_STATE_UPDATED,
1132 s->session_state = state;
1134 vec_reset_length (wrk->pending_session_wrk_updates);
1138 vcl_worker_flush_mq_events (vcl_worker_t *wrk)
1140 svm_msg_q_msg_t *msg;
1145 mq = wrk->app_event_queue;
1146 vcl_mq_dequeue_batch (wrk, mq, ~0);
1148 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
1150 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
1151 e = svm_msg_q_msg_data (mq, msg);
1152 vcl_handle_mq_event (wrk, e);
1153 svm_msg_q_free_msg (mq, msg);
1155 vec_reset_length (wrk->mq_msg_vector);
1156 vcl_handle_pending_wrk_updates (wrk);
1160 vcl_flush_mq_events (void)
1162 vcl_worker_flush_mq_events (vcl_worker_get_current ());
1166 vppcom_session_unbind (u32 session_handle)
1168 vcl_worker_t *wrk = vcl_worker_get_current ();
1169 session_accepted_msg_t *accepted_msg;
1170 vcl_session_t *session = 0;
1171 vcl_session_msg_t *evt;
1173 session = vcl_session_get_w_handle (wrk, session_handle);
1175 return VPPCOM_EBADFD;
1177 /* Flush pending accept events, if any */
1178 while (clib_fifo_elts (session->accept_evts_fifo))
1180 clib_fifo_sub2 (session->accept_evts_fifo, evt);
1181 accepted_msg = &evt->accepted_msg;
1182 vcl_session_table_del_vpp_handle (wrk, accepted_msg->handle);
1183 vcl_send_session_accepted_reply (session->vpp_evt_q,
1184 accepted_msg->context,
1185 accepted_msg->handle, -1);
1187 clib_fifo_free (session->accept_evts_fifo);
1189 vcl_send_session_unlisten (wrk, session);
1191 VDBG (1, "session %u [0x%llx]: sending unbind!", session->session_index,
1192 session->vpp_handle);
1193 vcl_evt (VCL_EVT_UNBIND, session);
1195 session->vpp_handle = ~0;
1196 session->session_state = VCL_STATE_DISCONNECT;
1204 * Notify vpp of the disconnect and mark the worker as free. If we're the
1205 * last worker, do a full cleanup otherwise, since we're probably a forked
1206 * child, avoid syscalls as much as possible. We might've lost privileges.
1209 vppcom_app_exit (void)
1211 if (!pool_elts (vcm->workers))
1213 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
1214 vcl_set_worker_index (~0);
1215 vcl_elog_stop (vcm);
1219 vcl_api_attach (void)
1221 if (vcm->cfg.vpp_app_socket_api)
1222 return vcl_sapi_attach ();
1224 return vcl_bapi_attach ();
1228 vcl_api_detach (vcl_worker_t * wrk)
1230 vcl_send_app_detach (wrk);
1232 if (vcm->cfg.vpp_app_socket_api)
1233 return vcl_sapi_detach (wrk);
1235 return vcl_bapi_disconnect_from_vpp ();
1239 * VPPCOM Public API functions
1242 vppcom_app_create (const char *app_name)
1244 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1249 VDBG (1, "already initialized");
1250 return VPPCOM_EEXIST;
1254 vppcom_cfg (&vcm->cfg);
1255 vcl_cfg = &vcm->cfg;
1257 vcm->main_cpu = pthread_self ();
1258 vcm->main_pid = getpid ();
1259 vcm->app_name = format (0, "%s", app_name);
1260 fifo_segment_main_init (&vcm->segment_main, (uword) ~0,
1261 20 /* timeout in secs */);
1262 pool_alloc (vcm->workers, vcl_cfg->max_workers);
1263 clib_spinlock_init (&vcm->workers_lock);
1264 clib_rwlock_init (&vcm->segment_table_lock);
1265 atexit (vppcom_app_exit);
1266 vcl_elog_init (vcm);
1268 /* Allocate default worker */
1269 vcl_worker_alloc_and_init ();
1271 if ((rv = vcl_api_attach ()))
1274 VDBG (0, "app_name '%s', my_client_index %d (0x%x)", app_name,
1275 vcm->workers[0].api_client_handle, vcm->workers[0].api_client_handle);
1281 vppcom_app_destroy (void)
1283 vcl_worker_t *wrk, *current_wrk;
1286 if (!pool_elts (vcm->workers))
1289 vcl_evt (VCL_EVT_DETACH, vcm);
1291 current_wrk = vcl_worker_get_current ();
1294 pool_foreach (wrk, vcm->workers) {
1295 if (current_wrk != wrk)
1296 vcl_worker_cleanup (wrk, 0 /* notify vpp */ );
1300 vcl_api_detach (current_wrk);
1301 vcl_worker_cleanup (current_wrk, 0 /* notify vpp */ );
1303 vcl_elog_stop (vcm);
1306 * Free the heap and fix vcm
1308 heap = clib_mem_get_heap ();
1309 munmap (clib_mem_get_heap_base (heap), clib_mem_get_heap_size (heap));
1311 vcm = &_vppcom_main;
1316 vppcom_session_create (u8 proto, u8 is_nonblocking)
1318 vcl_worker_t *wrk = vcl_worker_get_current ();
1319 vcl_session_t *session;
1321 session = vcl_session_alloc (wrk);
1323 session->session_type = proto;
1324 session->session_state = VCL_STATE_CLOSED;
1325 session->vpp_handle = ~0;
1326 session->is_dgram = vcl_proto_is_dgram (proto);
1329 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
1331 vcl_evt (VCL_EVT_CREATE, session, session_type, session->session_state,
1332 is_nonblocking, session_index);
1334 VDBG (0, "created session %u", session->session_index);
1336 return vcl_session_handle (session);
1340 vcl_epoll_lt_add (vcl_worker_t *wrk, vcl_session_t *s)
1342 vcl_session_t *cur, *prev;
1344 if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX)
1346 wrk->ep_lt_current = s->session_index;
1347 s->vep.lt_next = s->session_index;
1348 s->vep.lt_prev = s->session_index;
1352 cur = vcl_session_get (wrk, wrk->ep_lt_current);
1353 prev = vcl_session_get (wrk, cur->vep.lt_prev);
1355 prev->vep.lt_next = s->session_index;
1356 s->vep.lt_prev = prev->session_index;
1358 s->vep.lt_next = cur->session_index;
1359 cur->vep.lt_prev = s->session_index;
1363 vcl_epoll_lt_del (vcl_worker_t *wrk, vcl_session_t *s)
1365 vcl_session_t *prev, *next;
1367 if (s->vep.lt_next == s->session_index)
1369 wrk->ep_lt_current = VCL_INVALID_SESSION_INDEX;
1370 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
1374 prev = vcl_session_get (wrk, s->vep.lt_prev);
1375 next = vcl_session_get (wrk, s->vep.lt_next);
1377 prev->vep.lt_next = next->session_index;
1378 next->vep.lt_prev = prev->session_index;
1380 if (s->session_index == wrk->ep_lt_current)
1381 wrk->ep_lt_current = s->vep.lt_next;
1383 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
1387 vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * s,
1388 vcl_session_handle_t sh, u8 do_disconnect)
1392 VDBG (1, "session %u [0x%llx] closing", s->session_index, s->vpp_handle);
1394 if (s->flags & VCL_SESSION_F_IS_VEP)
1396 u32 next_sh = s->vep.next_sh;
1397 while (next_sh != ~0)
1399 rv = vppcom_epoll_ctl (sh, EPOLL_CTL_DEL, next_sh, 0);
1400 if (PREDICT_FALSE (rv < 0))
1401 VDBG (0, "vpp handle 0x%llx, sh %u: EPOLL_CTL_DEL vep_idx %u"
1402 " failed! rv %d (%s)", s->vpp_handle, next_sh,
1403 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1404 next_sh = s->vep.next_sh;
1409 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
1411 rv = vppcom_epoll_ctl (s->vep.vep_sh, EPOLL_CTL_DEL, sh, 0);
1413 VDBG (0, "session %u [0x%llx]: EPOLL_CTL_DEL vep_idx %u "
1414 "failed! rv %d (%s)", s->session_index, s->vpp_handle,
1415 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1420 VDBG (1, "session %u [0x%llx] disconnect skipped",
1421 s->session_index, s->vpp_handle);
1425 if (s->session_state == VCL_STATE_LISTEN)
1427 rv = vppcom_session_unbind (sh);
1428 if (PREDICT_FALSE (rv < 0))
1429 VDBG (0, "session %u [0x%llx]: listener unbind failed! "
1430 "rv %d (%s)", s->session_index, s->vpp_handle, rv,
1431 vppcom_retval_str (rv));
1434 else if (vcl_session_is_ready (s)
1435 || (vcl_session_is_connectable_listener (wrk, s)))
1437 rv = vppcom_session_disconnect (sh);
1438 if (PREDICT_FALSE (rv < 0))
1439 VDBG (0, "ERROR: session %u [0x%llx]: disconnect failed!"
1440 " rv %d (%s)", s->session_index, s->vpp_handle,
1441 rv, vppcom_retval_str (rv));
1443 else if (s->session_state == VCL_STATE_DISCONNECT)
1445 vcl_send_session_reset_reply (wrk, s, 0);
1447 else if (s->session_state == VCL_STATE_DETACHED)
1449 /* Should not happen. VPP cleaned up before app confirmed close */
1450 VDBG (0, "vpp freed session %d before close", s->session_index);
1454 s->session_state = VCL_STATE_CLOSED;
1456 /* Session is removed only after vpp confirms the disconnect */
1460 vcl_session_table_del_vpp_handle (wrk, s->vpp_handle);
1462 vcl_session_free (wrk, s);
1463 vcl_evt (VCL_EVT_CLOSE, s, rv);
1469 vppcom_session_close (uint32_t session_handle)
1471 vcl_worker_t *wrk = vcl_worker_get_current ();
1472 vcl_session_t *session;
1474 session = vcl_session_get_w_handle (wrk, session_handle);
1476 return VPPCOM_EBADFD;
1477 return vcl_session_cleanup (wrk, session, session_handle,
1478 1 /* do_disconnect */ );
1482 vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep)
1484 vcl_worker_t *wrk = vcl_worker_get_current ();
1485 vcl_session_t *session = 0;
1488 return VPPCOM_EINVAL;
1490 session = vcl_session_get_w_handle (wrk, session_handle);
1492 return VPPCOM_EBADFD;
1494 if (session->flags & VCL_SESSION_F_IS_VEP)
1496 VDBG (0, "ERROR: cannot bind to epoll session %u!",
1497 session->session_index);
1498 return VPPCOM_EBADFD;
1501 session->transport.is_ip4 = ep->is_ip4;
1503 clib_memcpy_fast (&session->transport.lcl_ip.ip4, ep->ip,
1504 sizeof (ip4_address_t));
1506 clib_memcpy_fast (&session->transport.lcl_ip.ip6, ep->ip,
1507 sizeof (ip6_address_t));
1508 session->transport.lcl_port = ep->port;
1511 "session %u handle %u: binding to local %s address %U port %u, "
1513 session->session_index, session_handle,
1514 session->transport.is_ip4 ? "IPv4" : "IPv6", vcl_format_ip46_address,
1515 &session->transport.lcl_ip,
1516 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1517 clib_net_to_host_u16 (session->transport.lcl_port),
1518 vppcom_proto_str (session->session_type));
1519 vcl_evt (VCL_EVT_BIND, session);
1521 if (session->session_type == VPPCOM_PROTO_UDP)
1522 vppcom_session_listen (session_handle, 10);
1528 vppcom_session_listen (uint32_t listen_sh, uint32_t q_len)
1530 vcl_worker_t *wrk = vcl_worker_get_current ();
1531 vcl_session_t *listen_session = 0;
1532 u64 listen_vpp_handle;
1535 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1536 if (!listen_session || (listen_session->flags & VCL_SESSION_F_IS_VEP))
1537 return VPPCOM_EBADFD;
1539 listen_vpp_handle = listen_session->vpp_handle;
1540 if (listen_session->session_state == VCL_STATE_LISTEN)
1542 VDBG (0, "session %u [0x%llx]: already in listen state!",
1543 listen_sh, listen_vpp_handle);
1547 VDBG (0, "session %u: sending vpp listen request...", listen_sh);
1550 * Send listen request to vpp and wait for reply
1552 vcl_send_session_listen (wrk, listen_session);
1553 rv = vppcom_wait_for_session_state_change (listen_session->session_index,
1555 vcm->cfg.session_timeout);
1557 if (PREDICT_FALSE (rv))
1559 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1560 VDBG (0, "session %u [0x%llx]: listen failed! returning %d (%s)",
1561 listen_sh, listen_session->vpp_handle, rv,
1562 vppcom_retval_str (rv));
1570 validate_args_session_accept_ (vcl_worker_t * wrk, vcl_session_t * ls)
1572 if (ls->flags & VCL_SESSION_F_IS_VEP)
1574 VDBG (0, "ERROR: cannot accept on epoll session %u!",
1576 return VPPCOM_EBADFD;
1579 if ((ls->session_state != VCL_STATE_LISTEN)
1580 && (!vcl_session_is_connectable_listener (wrk, ls)))
1583 "ERROR: session [0x%llx]: not in listen state! state 0x%x"
1585 ls->vpp_handle, ls->session_state,
1586 vcl_session_state_str (ls->session_state));
1587 return VPPCOM_EBADFD;
1593 vppcom_unformat_proto (uint8_t * proto, char *proto_str)
1595 if (!strcmp (proto_str, "TCP"))
1596 *proto = VPPCOM_PROTO_TCP;
1597 else if (!strcmp (proto_str, "tcp"))
1598 *proto = VPPCOM_PROTO_TCP;
1599 else if (!strcmp (proto_str, "UDP"))
1600 *proto = VPPCOM_PROTO_UDP;
1601 else if (!strcmp (proto_str, "udp"))
1602 *proto = VPPCOM_PROTO_UDP;
1603 else if (!strcmp (proto_str, "TLS"))
1604 *proto = VPPCOM_PROTO_TLS;
1605 else if (!strcmp (proto_str, "tls"))
1606 *proto = VPPCOM_PROTO_TLS;
1607 else if (!strcmp (proto_str, "QUIC"))
1608 *proto = VPPCOM_PROTO_QUIC;
1609 else if (!strcmp (proto_str, "quic"))
1610 *proto = VPPCOM_PROTO_QUIC;
1611 else if (!strcmp (proto_str, "DTLS"))
1612 *proto = VPPCOM_PROTO_DTLS;
1613 else if (!strcmp (proto_str, "dtls"))
1614 *proto = VPPCOM_PROTO_DTLS;
1615 else if (!strcmp (proto_str, "SRTP"))
1616 *proto = VPPCOM_PROTO_SRTP;
1617 else if (!strcmp (proto_str, "srtp"))
1618 *proto = VPPCOM_PROTO_SRTP;
1625 vppcom_session_accept (uint32_t listen_session_handle, vppcom_endpt_t * ep,
1628 u32 client_session_index = ~0, listen_session_index, accept_flags = 0;
1629 vcl_worker_t *wrk = vcl_worker_get_current ();
1630 session_accepted_msg_t accepted_msg;
1631 vcl_session_t *listen_session = 0;
1632 vcl_session_t *client_session = 0;
1633 vcl_session_msg_t *evt;
1639 listen_session = vcl_session_get_w_handle (wrk, listen_session_handle);
1640 if (!listen_session)
1641 return VPPCOM_EBADFD;
1643 listen_session_index = listen_session->session_index;
1644 if ((rv = validate_args_session_accept_ (wrk, listen_session)))
1647 if (clib_fifo_elts (listen_session->accept_evts_fifo))
1649 clib_fifo_sub2 (listen_session->accept_evts_fifo, evt);
1650 accept_flags = evt->flags;
1651 accepted_msg = evt->accepted_msg;
1655 is_nonblocking = vcl_session_has_attr (listen_session,
1656 VCL_SESS_ATTR_NONBLOCK);
1659 if (svm_msg_q_is_empty (wrk->app_event_queue) && is_nonblocking)
1660 return VPPCOM_EAGAIN;
1662 svm_msg_q_wait (wrk->app_event_queue, SVM_MQ_WAIT_EMPTY);
1663 vcl_worker_flush_mq_events (wrk);
1669 client_session_index = vcl_session_accepted_handler (wrk, &accepted_msg,
1670 listen_session_index);
1671 if (client_session_index == VCL_INVALID_SESSION_INDEX)
1672 return VPPCOM_ECONNABORTED;
1674 listen_session = vcl_session_get (wrk, listen_session_index);
1675 client_session = vcl_session_get (wrk, client_session_index);
1677 if (flags & O_NONBLOCK)
1678 vcl_session_set_attr (client_session, VCL_SESS_ATTR_NONBLOCK);
1680 VDBG (1, "listener %u [0x%llx]: Got a connect request! session %u [0x%llx],"
1681 " flags %d, is_nonblocking %u", listen_session->session_index,
1682 listen_session->vpp_handle, client_session_index,
1683 client_session->vpp_handle, flags,
1684 vcl_session_has_attr (client_session, VCL_SESS_ATTR_NONBLOCK));
1688 ep->is_ip4 = client_session->transport.is_ip4;
1689 ep->port = client_session->transport.rmt_port;
1690 if (client_session->transport.is_ip4)
1691 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip4,
1692 sizeof (ip4_address_t));
1694 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip6,
1695 sizeof (ip6_address_t));
1699 "listener %u [0x%llx] accepted %u [0x%llx] peer: %U:%u "
1701 listen_session_handle, listen_session->vpp_handle,
1702 client_session_index, client_session->vpp_handle,
1703 vcl_format_ip46_address, &client_session->transport.rmt_ip,
1704 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1705 clib_net_to_host_u16 (client_session->transport.rmt_port),
1706 vcl_format_ip46_address, &client_session->transport.lcl_ip,
1707 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1708 clib_net_to_host_u16 (client_session->transport.lcl_port));
1709 vcl_evt (VCL_EVT_ACCEPT, client_session, listen_session,
1710 client_session_index);
1713 * Session might have been closed already
1717 if (accept_flags & VCL_ACCEPTED_F_CLOSED)
1718 client_session->session_state = VCL_STATE_VPP_CLOSING;
1719 else if (accept_flags & VCL_ACCEPTED_F_RESET)
1720 client_session->session_state = VCL_STATE_DISCONNECT;
1722 return vcl_session_handle (client_session);
1726 vppcom_session_connect (uint32_t session_handle, vppcom_endpt_t * server_ep)
1728 vcl_worker_t *wrk = vcl_worker_get_current ();
1729 vcl_session_t *session = 0;
1733 session = vcl_session_get_w_handle (wrk, session_handle);
1735 return VPPCOM_EBADFD;
1736 session_index = session->session_index;
1738 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1740 VDBG (0, "ERROR: cannot connect epoll session %u!",
1741 session->session_index);
1742 return VPPCOM_EBADFD;
1745 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1748 "session handle %u [0x%llx]: session already "
1749 "connected to %s %U port %d proto %s, state 0x%x (%s)",
1750 session_handle, session->vpp_handle,
1751 session->transport.is_ip4 ? "IPv4" : "IPv6",
1752 vcl_format_ip46_address, &session->transport.rmt_ip,
1753 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1754 clib_net_to_host_u16 (session->transport.rmt_port),
1755 vppcom_proto_str (session->session_type), session->session_state,
1756 vcl_session_state_str (session->session_state));
1760 /* Attempt to connect a connectionless listener */
1761 if (PREDICT_FALSE (session->session_state == VCL_STATE_LISTEN))
1763 if (session->session_type != VPPCOM_PROTO_UDP)
1764 return VPPCOM_EINVAL;
1765 vcl_send_session_unlisten (wrk, session);
1766 session->session_state = VCL_STATE_CLOSED;
1769 session->transport.is_ip4 = server_ep->is_ip4;
1770 vcl_ip_copy_from_ep (&session->transport.rmt_ip, server_ep);
1771 session->transport.rmt_port = server_ep->port;
1772 session->parent_handle = VCL_INVALID_SESSION_HANDLE;
1773 session->flags |= VCL_SESSION_F_CONNECTED;
1776 "session handle %u (%s): connecting to peer %s %U "
1778 session_handle, vcl_session_state_str (session->session_state),
1779 session->transport.is_ip4 ? "IPv4" : "IPv6", vcl_format_ip46_address,
1780 &session->transport.rmt_ip,
1781 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1782 clib_net_to_host_u16 (session->transport.rmt_port),
1783 vppcom_proto_str (session->session_type));
1785 vcl_send_session_connect (wrk, session);
1787 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK))
1789 /* State set to STATE_UPDATED to ensure the session is not assumed
1790 * to be ready and to also allow the app to close it prior to vpp's
1791 * connected reply. */
1792 session->session_state = VCL_STATE_UPDATED;
1793 return VPPCOM_EINPROGRESS;
1797 * Wait for reply from vpp if blocking
1799 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1800 vcm->cfg.session_timeout);
1802 session = vcl_session_get (wrk, session_index);
1803 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1804 session->vpp_handle, rv ? "failed" : "succeeded");
1810 vppcom_session_stream_connect (uint32_t session_handle,
1811 uint32_t parent_session_handle)
1813 vcl_worker_t *wrk = vcl_worker_get_current ();
1814 vcl_session_t *session, *parent_session;
1815 u32 session_index, parent_session_index;
1818 session = vcl_session_get_w_handle (wrk, session_handle);
1820 return VPPCOM_EBADFD;
1821 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1822 if (!parent_session)
1823 return VPPCOM_EBADFD;
1825 session_index = session->session_index;
1826 parent_session_index = parent_session->session_index;
1827 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1829 VDBG (0, "ERROR: cannot connect epoll session %u!",
1830 session->session_index);
1831 return VPPCOM_EBADFD;
1834 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1837 "session handle %u [0x%llx]: session already "
1838 "connected to session %u [0x%llx] proto %s, state 0x%x (%s)",
1839 session_handle, session->vpp_handle, parent_session_handle,
1840 parent_session->vpp_handle,
1841 vppcom_proto_str (session->session_type), session->session_state,
1842 vcl_session_state_str (session->session_state));
1846 /* Connect to quic session specifics */
1847 session->transport.is_ip4 = parent_session->transport.is_ip4;
1848 session->transport.rmt_ip.ip4.as_u32 = (uint32_t) 1;
1849 session->transport.rmt_port = 0;
1850 session->parent_handle = parent_session->vpp_handle;
1852 VDBG (0, "session handle %u: connecting to session %u [0x%llx]",
1853 session_handle, parent_session_handle, parent_session->vpp_handle);
1856 * Send connect request and wait for reply from vpp
1858 vcl_send_session_connect (wrk, session);
1859 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1860 vcm->cfg.session_timeout);
1862 session->listener_index = parent_session_index;
1863 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1865 parent_session->n_accepted_sessions++;
1867 session = vcl_session_get (wrk, session_index);
1868 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1869 session->vpp_handle, rv ? "failed" : "succeeded");
1875 vppcom_session_read_internal (uint32_t session_handle, void *buf, int n,
1878 vcl_worker_t *wrk = vcl_worker_get_current ();
1879 int rv, n_read = 0, is_nonblocking;
1880 vcl_session_t *s = 0;
1881 svm_fifo_t *rx_fifo;
1886 if (PREDICT_FALSE (!buf))
1887 return VPPCOM_EFAULT;
1889 s = vcl_session_get_w_handle (wrk, session_handle);
1890 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
1891 return VPPCOM_EBADFD;
1893 if (PREDICT_FALSE (!vcl_session_is_open (s)))
1895 VDBG (0, "session %u[0x%llx] is not open! state 0x%x (%s)",
1896 s->session_index, s->vpp_handle, s->session_state,
1897 vcl_session_state_str (s->session_state));
1898 return vcl_session_closed_error (s);
1901 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_RD_SHUTDOWN))
1903 /* Vpp would ack the incoming data and enqueue it for reading.
1904 * So even if SHUT_RD is set, we can still read() the data if
1905 * the session is ready.
1907 if (!vcl_session_read_ready (s))
1913 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
1914 is_ct = vcl_session_is_ct (s);
1915 mq = wrk->app_event_queue;
1916 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
1917 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
1919 if (svm_fifo_is_empty_cons (rx_fifo))
1923 if (vcl_session_is_closing (s))
1924 return vcl_session_closing_error (s);
1926 svm_fifo_unset_event (s->rx_fifo);
1927 svm_fifo_unset_event (rx_fifo);
1928 return VPPCOM_EWOULDBLOCK;
1930 while (svm_fifo_is_empty_cons (rx_fifo))
1932 if (vcl_session_is_closing (s))
1933 return vcl_session_closing_error (s);
1936 svm_fifo_unset_event (s->rx_fifo);
1937 svm_fifo_unset_event (rx_fifo);
1939 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
1940 vcl_worker_flush_mq_events (wrk);
1947 rv = app_recv_dgram_raw (rx_fifo, buf, n, &s->transport, 0, peek);
1949 rv = app_recv_stream_raw (rx_fifo, buf, n, 0, peek);
1958 if (svm_fifo_is_empty_cons (rx_fifo))
1961 svm_fifo_unset_event (s->rx_fifo);
1962 svm_fifo_unset_event (rx_fifo);
1963 if (!svm_fifo_is_empty_cons (rx_fifo)
1964 && svm_fifo_set_event (rx_fifo) && is_nonblocking)
1966 vec_add2 (wrk->unhandled_evts_vector, e, 1);
1967 e->event_type = SESSION_IO_EVT_RX;
1968 e->session_index = s->session_index;
1971 else if (PREDICT_FALSE (rv < n && !s->is_dgram))
1973 /* More data enqueued while reading. Try to drain it
1974 * or fill the buffer. Avoid doing that for dgrams */
1980 if (PREDICT_FALSE (svm_fifo_needs_deq_ntf (rx_fifo, n_read)))
1982 svm_fifo_clear_deq_ntf (rx_fifo);
1983 app_send_io_evt_to_vpp (s->vpp_evt_q,
1984 s->rx_fifo->shr->master_session_index,
1985 SESSION_IO_EVT_RX, SVM_Q_WAIT);
1988 VDBG (2, "session %u[0x%llx]: read %d bytes from (%p)", s->session_index,
1989 s->vpp_handle, n_read, rx_fifo);
1995 vppcom_session_read (uint32_t session_handle, void *buf, size_t n)
1997 return (vppcom_session_read_internal (session_handle, buf, n, 0));
2001 vppcom_session_peek (uint32_t session_handle, void *buf, int n)
2003 return (vppcom_session_read_internal (session_handle, buf, n, 1));
2007 vppcom_session_read_segments (uint32_t session_handle,
2008 vppcom_data_segment_t * ds, uint32_t n_segments,
2011 vcl_worker_t *wrk = vcl_worker_get_current ();
2012 int n_read = 0, is_nonblocking;
2013 vcl_session_t *s = 0;
2014 svm_fifo_t *rx_fifo;
2018 s = vcl_session_get_w_handle (wrk, session_handle);
2019 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2020 return VPPCOM_EBADFD;
2022 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2023 return vcl_session_closed_error (s);
2025 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2026 is_ct = vcl_session_is_ct (s);
2027 mq = wrk->app_event_queue;
2028 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
2029 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2031 if (svm_fifo_is_empty_cons (rx_fifo))
2036 svm_fifo_unset_event (s->rx_fifo);
2037 svm_fifo_unset_event (rx_fifo);
2038 return VPPCOM_EWOULDBLOCK;
2040 while (svm_fifo_is_empty_cons (rx_fifo))
2042 if (vcl_session_is_closing (s))
2043 return vcl_session_closing_error (s);
2046 svm_fifo_unset_event (s->rx_fifo);
2047 svm_fifo_unset_event (rx_fifo);
2049 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2050 vcl_worker_flush_mq_events (wrk);
2054 n_read = svm_fifo_segments (rx_fifo, s->rx_bytes_pending,
2055 (svm_fifo_seg_t *) ds, n_segments, max_bytes);
2057 return VPPCOM_EAGAIN;
2059 if (svm_fifo_max_dequeue_cons (rx_fifo) == n_read)
2062 svm_fifo_unset_event (s->rx_fifo);
2063 svm_fifo_unset_event (rx_fifo);
2064 if (svm_fifo_max_dequeue_cons (rx_fifo) != n_read
2065 && svm_fifo_set_event (rx_fifo)
2066 && vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
2069 vec_add2 (wrk->unhandled_evts_vector, e, 1);
2070 e->event_type = SESSION_IO_EVT_RX;
2071 e->session_index = s->session_index;
2075 s->rx_bytes_pending += n_read;
2080 vppcom_session_free_segments (uint32_t session_handle, uint32_t n_bytes)
2082 vcl_worker_t *wrk = vcl_worker_get_current ();
2086 s = vcl_session_get_w_handle (wrk, session_handle);
2087 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2090 is_ct = vcl_session_is_ct (s);
2091 svm_fifo_dequeue_drop (is_ct ? s->ct_rx_fifo : s->rx_fifo, n_bytes);
2093 ASSERT (s->rx_bytes_pending >= n_bytes);
2094 s->rx_bytes_pending -= n_bytes;
2098 vcl_fifo_is_writeable (svm_fifo_t * f, u32 len, u8 is_dgram)
2100 u32 max_enq = svm_fifo_max_enqueue_prod (f);
2102 return max_enq >= (sizeof (session_dgram_hdr_t) + len);
2108 vppcom_session_write_inline (vcl_worker_t * wrk, vcl_session_t * s, void *buf,
2109 size_t n, u8 is_flush, u8 is_dgram)
2111 int n_write, is_nonblocking;
2112 session_evt_type_t et;
2113 svm_fifo_t *tx_fifo;
2117 /* Accept zero length writes but just return */
2118 if (PREDICT_FALSE (!n))
2121 if (PREDICT_FALSE (!buf))
2122 return VPPCOM_EFAULT;
2124 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2126 VDBG (0, "ERROR: session %u [0x%llx]: cannot write to an epoll"
2127 " session!", s->session_index, s->vpp_handle);
2128 return VPPCOM_EBADFD;
2131 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2133 VDBG (1, "session %u [0x%llx]: is not open! state 0x%x (%s)",
2134 s->session_index, s->vpp_handle, s->session_state,
2135 vcl_session_state_str (s->session_state));
2136 return vcl_session_closed_error (s);;
2139 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_WR_SHUTDOWN))
2141 VDBG (1, "session %u [0x%llx]: is shutdown! state 0x%x (%s)",
2142 s->session_index, s->vpp_handle, s->session_state,
2143 vcl_session_state_str (s->session_state));
2144 return VPPCOM_EPIPE;
2147 is_ct = vcl_session_is_ct (s);
2148 tx_fifo = is_ct ? s->ct_tx_fifo : s->tx_fifo;
2149 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2151 mq = wrk->app_event_queue;
2152 if (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2156 return VPPCOM_EWOULDBLOCK;
2158 while (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2160 svm_fifo_add_want_deq_ntf (tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
2161 if (vcl_session_is_closing (s))
2162 return vcl_session_closing_error (s);
2164 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2165 vcl_worker_flush_mq_events (wrk);
2169 et = SESSION_IO_EVT_TX;
2170 if (is_flush && !is_ct)
2171 et = SESSION_IO_EVT_TX_FLUSH;
2174 n_write = app_send_dgram_raw (tx_fifo, &s->transport,
2175 s->vpp_evt_q, buf, n, et,
2176 0 /* do_evt */ , SVM_Q_WAIT);
2178 n_write = app_send_stream_raw (tx_fifo, s->vpp_evt_q, buf, n, et,
2179 0 /* do_evt */ , SVM_Q_WAIT);
2181 if (svm_fifo_set_event (s->tx_fifo))
2182 app_send_io_evt_to_vpp (
2183 s->vpp_evt_q, s->tx_fifo->shr->master_session_index, et, SVM_Q_WAIT);
2185 /* The underlying fifo segment can run out of memory */
2186 if (PREDICT_FALSE (n_write < 0))
2187 return VPPCOM_EAGAIN;
2189 VDBG (2, "session %u [0x%llx]: wrote %d bytes", s->session_index,
2190 s->vpp_handle, n_write);
2196 vppcom_session_write (uint32_t session_handle, void *buf, size_t n)
2198 vcl_worker_t *wrk = vcl_worker_get_current ();
2201 s = vcl_session_get_w_handle (wrk, session_handle);
2202 if (PREDICT_FALSE (!s))
2203 return VPPCOM_EBADFD;
2205 return vppcom_session_write_inline (wrk, s, buf, n,
2206 0 /* is_flush */ , s->is_dgram ? 1 : 0);
2210 vppcom_session_write_msg (uint32_t session_handle, void *buf, size_t n)
2212 vcl_worker_t *wrk = vcl_worker_get_current ();
2215 s = vcl_session_get_w_handle (wrk, session_handle);
2216 if (PREDICT_FALSE (!s))
2217 return VPPCOM_EBADFD;
2219 return vppcom_session_write_inline (wrk, s, buf, n,
2220 1 /* is_flush */ , s->is_dgram ? 1 : 0);
2223 #define vcl_fifo_rx_evt_valid_or_break(_s) \
2224 if (PREDICT_FALSE (!_s->rx_fifo)) \
2226 if (PREDICT_FALSE (svm_fifo_is_empty (_s->rx_fifo))) \
2228 if (!vcl_session_is_ct (_s)) \
2230 svm_fifo_unset_event (_s->rx_fifo); \
2231 if (svm_fifo_is_empty (_s->rx_fifo)) \
2234 else if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2236 svm_fifo_unset_event (_s->rx_fifo); /* rx evts on actual fifo*/ \
2237 if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2243 vcl_select_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2244 unsigned long n_bits, unsigned long *read_map,
2245 unsigned long *write_map,
2246 unsigned long *except_map, u32 * bits_set)
2248 session_disconnected_msg_t *disconnected_msg;
2249 session_connected_msg_t *connected_msg;
2253 switch (e->event_type)
2255 case SESSION_IO_EVT_RX:
2256 sid = e->session_index;
2257 s = vcl_session_get (wrk, sid);
2258 if (!s || !vcl_session_is_open (s))
2260 vcl_fifo_rx_evt_valid_or_break (s);
2261 if (sid < n_bits && read_map)
2263 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2267 case SESSION_IO_EVT_TX:
2268 sid = e->session_index;
2269 s = vcl_session_get (wrk, sid);
2270 if (!s || !vcl_session_is_open (s))
2272 if (sid < n_bits && write_map)
2274 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2278 case SESSION_CTRL_EVT_ACCEPTED:
2280 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
2282 s = vcl_session_get (wrk, e->session_index);
2285 sid = s->session_index;
2286 if (sid < n_bits && read_map)
2288 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2292 case SESSION_CTRL_EVT_CONNECTED:
2295 connected_msg = (session_connected_msg_t *) e->data;
2296 sid = vcl_session_connected_handler (wrk, connected_msg);
2299 sid = e->session_index;
2300 if (sid == VCL_INVALID_SESSION_INDEX)
2302 if (sid < n_bits && write_map)
2304 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2308 case SESSION_CTRL_EVT_DISCONNECTED:
2309 disconnected_msg = (session_disconnected_msg_t *) e->data;
2310 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
2313 sid = s->session_index;
2314 if (sid < n_bits && except_map)
2316 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2320 case SESSION_CTRL_EVT_RESET:
2321 sid = vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
2322 if (sid < n_bits && except_map)
2324 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2328 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
2329 vcl_session_unlisten_reply_handler (wrk, e->data);
2331 case SESSION_CTRL_EVT_MIGRATED:
2332 vcl_session_migrated_handler (wrk, e->data);
2334 case SESSION_CTRL_EVT_CLEANUP:
2335 vcl_session_cleanup_handler (wrk, e->data);
2337 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
2338 vcl_session_worker_update_reply_handler (wrk, e->data);
2340 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
2341 vcl_session_req_worker_update_handler (wrk, e->data);
2343 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
2344 vcl_session_app_add_segment_handler (wrk, e->data);
2346 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
2347 vcl_session_app_del_segment_handler (wrk, e->data);
2349 case SESSION_CTRL_EVT_APP_WRK_RPC:
2350 vcl_worker_rpc_handler (wrk, e->data);
2353 clib_warning ("unhandled: %u", e->event_type);
2359 vcl_select_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
2360 unsigned long n_bits, unsigned long *read_map,
2361 unsigned long *write_map, unsigned long *except_map,
2362 double time_to_wait, u32 * bits_set)
2364 svm_msg_q_msg_t *msg;
2368 if (svm_msg_q_is_empty (mq))
2375 else if (time_to_wait < 0)
2376 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2379 if (svm_msg_q_timedwait (mq, time_to_wait))
2383 vcl_mq_dequeue_batch (wrk, mq, ~0);
2385 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
2387 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
2388 e = svm_msg_q_msg_data (mq, msg);
2389 vcl_select_handle_mq_event (wrk, e, n_bits, read_map, write_map,
2390 except_map, bits_set);
2391 svm_msg_q_free_msg (mq, msg);
2393 vec_reset_length (wrk->mq_msg_vector);
2394 vcl_handle_pending_wrk_updates (wrk);
2399 vppcom_select_condvar (vcl_worker_t * wrk, int n_bits,
2400 vcl_si_set * read_map, vcl_si_set * write_map,
2401 vcl_si_set * except_map, double time_to_wait,
2404 double wait = 0, start = 0;
2408 wait = time_to_wait;
2409 start = clib_time_now (&wrk->clib_time);
2414 vcl_select_handle_mq (wrk, wrk->app_event_queue, n_bits, read_map,
2415 write_map, except_map, wait, bits_set);
2421 wait = wait - (clib_time_now (&wrk->clib_time) - start);
2429 vppcom_select_eventfd (vcl_worker_t * wrk, int n_bits,
2430 vcl_si_set * read_map, vcl_si_set * write_map,
2431 vcl_si_set * except_map, double time_to_wait,
2434 vcl_mq_evt_conn_t *mqc;
2435 int __clib_unused n_read;
2439 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
2440 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
2441 vec_len (wrk->mq_events), time_to_wait);
2442 for (i = 0; i < n_mq_evts; i++)
2444 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
2445 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
2446 vcl_select_handle_mq (wrk, mqc->mq, n_bits, read_map, write_map,
2447 except_map, 0, bits_set);
2450 return (n_mq_evts > 0 ? (int) *bits_set : 0);
2454 vppcom_select (int n_bits, vcl_si_set * read_map, vcl_si_set * write_map,
2455 vcl_si_set * except_map, double time_to_wait)
2457 u32 sid, minbits = clib_max (n_bits, BITS (uword)), bits_set = 0;
2458 vcl_worker_t *wrk = vcl_worker_get_current ();
2459 vcl_session_t *s = 0;
2462 if (n_bits && read_map)
2464 clib_bitmap_validate (wrk->rd_bitmap, minbits);
2465 clib_memcpy_fast (wrk->rd_bitmap, read_map,
2466 vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2467 memset (read_map, 0, vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2469 if (n_bits && write_map)
2471 clib_bitmap_validate (wrk->wr_bitmap, minbits);
2472 clib_memcpy_fast (wrk->wr_bitmap, write_map,
2473 vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2474 memset (write_map, 0, vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2476 if (n_bits && except_map)
2478 clib_bitmap_validate (wrk->ex_bitmap, minbits);
2479 clib_memcpy_fast (wrk->ex_bitmap, except_map,
2480 vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2481 memset (except_map, 0, vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2490 clib_bitmap_foreach (sid, wrk->wr_bitmap)
2492 if (!(s = vcl_session_get (wrk, sid)))
2494 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2499 if (vcl_session_write_ready (s))
2501 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2506 svm_fifo_t *txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2507 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF);
2515 clib_bitmap_foreach (sid, wrk->rd_bitmap)
2517 if (!(s = vcl_session_get (wrk, sid)))
2519 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2524 if (vcl_session_read_ready (s))
2526 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2533 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
2535 vcl_select_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i], n_bits,
2536 read_map, write_map, except_map, &bits_set);
2538 vec_reset_length (wrk->unhandled_evts_vector);
2540 if (vcm->cfg.use_mq_eventfd)
2541 vppcom_select_eventfd (wrk, n_bits, read_map, write_map, except_map,
2542 time_to_wait, &bits_set);
2544 vppcom_select_condvar (wrk, n_bits, read_map, write_map, except_map,
2545 time_to_wait, &bits_set);
2551 vep_verify_epoll_chain (vcl_worker_t * wrk, u32 vep_handle)
2553 vppcom_epoll_t *vep;
2554 u32 sh = vep_handle;
2557 if (VPPCOM_DEBUG <= 2)
2560 s = vcl_session_get_w_handle (wrk, vep_handle);
2561 if (PREDICT_FALSE (!s))
2563 VDBG (0, "ERROR: Invalid vep_sh (%u)!", vep_handle);
2566 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP)))
2568 VDBG (0, "ERROR: vep_sh (%u) is not a vep!", vep_handle);
2572 VDBG (0, "vep_sh (%u): Dumping epoll chain\n"
2575 " is_vep_session = %u\n"
2576 " next_sh = 0x%x (%u)\n"
2577 "}\n", vep_handle, s->flags & VCL_SESSION_F_IS_VEP,
2578 s->flags & VCL_SESSION_F_IS_VEP_SESSION, vep->next_sh, vep->next_sh);
2580 for (sh = vep->next_sh; sh != ~0; sh = vep->next_sh)
2582 s = vcl_session_get_w_handle (wrk, sh);
2583 if (PREDICT_FALSE (!s))
2585 VDBG (0, "ERROR: Invalid sh (%u)!", sh);
2588 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2590 VDBG (0, "ERROR: sh (%u) is a vep!", vep_handle);
2592 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2594 VDBG (0, "ERROR: sh (%u) is not a vep session handle!", sh);
2598 if (PREDICT_FALSE (vep->vep_sh != vep_handle))
2599 VDBG (0, "ERROR: session (%u) vep_sh (%u) != vep_sh (%u)!",
2600 sh, s->vep.vep_sh, vep_handle);
2601 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2603 VDBG (0, "vep_sh[%u]: sh 0x%x (%u)\n"
2605 " next_sh = 0x%x (%u)\n"
2606 " prev_sh = 0x%x (%u)\n"
2607 " vep_sh = 0x%x (%u)\n"
2608 " ev.events = 0x%x\n"
2609 " ev.data.u64 = 0x%llx\n"
2612 vep_handle, sh, sh, vep->next_sh, vep->next_sh, vep->prev_sh,
2613 vep->prev_sh, vep->vep_sh, vep->vep_sh, vep->ev.events,
2614 vep->ev.data.u64, vep->et_mask);
2619 VDBG (0, "vep_sh (%u): Dump complete!\n", vep_handle);
2623 vppcom_epoll_create (void)
2625 vcl_worker_t *wrk = vcl_worker_get_current ();
2626 vcl_session_t *vep_session;
2628 vep_session = vcl_session_alloc (wrk);
2630 vep_session->flags |= VCL_SESSION_F_IS_VEP;
2631 vep_session->vep.vep_sh = ~0;
2632 vep_session->vep.next_sh = ~0;
2633 vep_session->vep.prev_sh = ~0;
2634 vep_session->vpp_handle = ~0;
2636 vcl_evt (VCL_EVT_EPOLL_CREATE, vep_session, vep_session->session_index);
2637 VDBG (0, "Created vep_idx %u", vep_session->session_index);
2639 return vcl_session_handle (vep_session);
2643 vppcom_epoll_ctl (uint32_t vep_handle, int op, uint32_t session_handle,
2644 struct epoll_event *event)
2646 vcl_worker_t *wrk = vcl_worker_get_current ();
2647 int rv = VPPCOM_OK, add_evt = 0;
2648 vcl_session_t *vep_session;
2652 if (vep_handle == session_handle)
2654 VDBG (0, "vep_sh == session handle (%u)!", vep_handle);
2655 return VPPCOM_EINVAL;
2658 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
2659 if (PREDICT_FALSE (!vep_session))
2661 VDBG (0, "Invalid vep_sh (%u)!", vep_handle);
2662 return VPPCOM_EBADFD;
2664 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
2666 VDBG (0, "vep_sh (%u) is not a vep!", vep_handle);
2667 return VPPCOM_EINVAL;
2670 ASSERT (vep_session->vep.vep_sh == ~0);
2671 ASSERT (vep_session->vep.prev_sh == ~0);
2673 s = vcl_session_get_w_handle (wrk, session_handle);
2674 if (PREDICT_FALSE (!s))
2676 VDBG (0, "Invalid session_handle (%u)!", session_handle);
2677 return VPPCOM_EBADFD;
2679 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2681 VDBG (0, "session_handle (%u) is a vep!", vep_handle);
2682 return VPPCOM_EINVAL;
2688 if (PREDICT_FALSE (!event))
2690 VDBG (0, "EPOLL_CTL_ADD: NULL pointer to epoll_event structure!");
2691 return VPPCOM_EINVAL;
2693 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2695 VDBG (0, "EPOLL_CTL_ADD: %u already epolled!", s->session_index);
2699 if (vep_session->vep.next_sh != ~0)
2701 vcl_session_t *next_session;
2702 next_session = vcl_session_get_w_handle (wrk,
2703 vep_session->vep.next_sh);
2704 if (PREDICT_FALSE (!next_session))
2706 VDBG (0, "EPOLL_CTL_ADD: Invalid vep.next_sh (%u) on "
2707 "vep_idx (%u)!", vep_session->vep.next_sh, vep_handle);
2708 return VPPCOM_EBADFD;
2710 ASSERT (next_session->vep.prev_sh == vep_handle);
2711 next_session->vep.prev_sh = session_handle;
2713 s->vep.next_sh = vep_session->vep.next_sh;
2714 s->vep.prev_sh = vep_handle;
2715 s->vep.vep_sh = vep_handle;
2716 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2717 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
2719 s->flags &= ~VCL_SESSION_F_IS_VEP;
2720 s->flags |= VCL_SESSION_F_IS_VEP_SESSION;
2721 vep_session->vep.next_sh = session_handle;
2723 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2724 if (txf && (event->events & EPOLLOUT))
2725 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2727 /* Generate EPOLLOUT if tx fifo not full */
2728 if ((event->events & EPOLLOUT) && (vcl_session_write_ready (s) > 0))
2730 session_event_t e = { 0 };
2731 e.event_type = SESSION_IO_EVT_TX;
2732 e.session_index = s->session_index;
2733 vec_add1 (wrk->unhandled_evts_vector, e);
2736 /* Generate EPOLLIN if rx fifo has data */
2737 if ((event->events & EPOLLIN) && (vcl_session_read_ready (s) > 0))
2739 session_event_t e = { 0 };
2740 e.event_type = SESSION_IO_EVT_RX;
2741 e.session_index = s->session_index;
2742 vec_add1 (wrk->unhandled_evts_vector, e);
2743 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2746 if (!add_evt && vcl_session_is_closing (s))
2748 session_event_t e = { 0 };
2749 if (s->session_state == VCL_STATE_VPP_CLOSING)
2750 e.event_type = SESSION_CTRL_EVT_DISCONNECTED;
2752 e.event_type = SESSION_CTRL_EVT_RESET;
2753 e.session_index = s->session_index;
2755 vec_add1 (wrk->unhandled_evts_vector, e);
2757 VDBG (1, "EPOLL_CTL_ADD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2758 vep_handle, session_handle, event->events, event->data.u64);
2759 vcl_evt (VCL_EVT_EPOLL_CTLADD, s, event->events, event->data.u64);
2763 if (PREDICT_FALSE (!event))
2765 VDBG (0, "EPOLL_CTL_MOD: NULL pointer to epoll_event structure!");
2769 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2771 VDBG (0, "sh %u EPOLL_CTL_MOD: not a vep session!", session_handle);
2775 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2777 VDBG (0, "EPOLL_CTL_MOD: sh %u vep_sh (%u) != vep_sh (%u)!",
2778 session_handle, s->vep.vep_sh, vep_handle);
2783 /* Generate EPOLLOUT if session write ready nd event was not on */
2784 if ((event->events & EPOLLOUT) && !(s->vep.ev.events & EPOLLOUT) &&
2785 (vcl_session_write_ready (s) > 0))
2787 session_event_t e = { 0 };
2788 e.event_type = SESSION_IO_EVT_TX;
2789 e.session_index = s->session_index;
2790 vec_add1 (wrk->unhandled_evts_vector, e);
2792 /* Generate EPOLLIN if session read ready and event was not on */
2793 if ((event->events & EPOLLIN) && !(s->vep.ev.events & EPOLLIN) &&
2794 (vcl_session_read_ready (s) > 0))
2796 session_event_t e = { 0 };
2797 e.event_type = SESSION_IO_EVT_RX;
2798 e.session_index = s->session_index;
2799 vec_add1 (wrk->unhandled_evts_vector, e);
2800 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2802 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2804 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2807 if (event->events & EPOLLOUT)
2808 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2810 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2812 VDBG (1, "EPOLL_CTL_MOD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2813 vep_handle, session_handle, event->events, event->data.u64);
2817 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2819 VDBG (0, "EPOLL_CTL_DEL: %u not a vep session!", session_handle);
2823 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2825 VDBG (0, "EPOLL_CTL_DEL: sh %u vep_sh (%u) != vep_sh (%u)!",
2826 session_handle, s->vep.vep_sh, vep_handle);
2831 if (s->vep.prev_sh == vep_handle)
2832 vep_session->vep.next_sh = s->vep.next_sh;
2835 vcl_session_t *prev_session;
2836 prev_session = vcl_session_get_w_handle (wrk, s->vep.prev_sh);
2837 if (PREDICT_FALSE (!prev_session))
2839 VDBG (0, "EPOLL_CTL_DEL: Invalid prev_sh (%u) on sh (%u)!",
2840 s->vep.prev_sh, session_handle);
2841 return VPPCOM_EBADFD;
2843 ASSERT (prev_session->vep.next_sh == session_handle);
2844 prev_session->vep.next_sh = s->vep.next_sh;
2846 if (s->vep.next_sh != ~0)
2848 vcl_session_t *next_session;
2849 next_session = vcl_session_get_w_handle (wrk, s->vep.next_sh);
2850 if (PREDICT_FALSE (!next_session))
2852 VDBG (0, "EPOLL_CTL_DEL: Invalid next_sh (%u) on sh (%u)!",
2853 s->vep.next_sh, session_handle);
2854 return VPPCOM_EBADFD;
2856 ASSERT (next_session->vep.prev_sh == session_handle);
2857 next_session->vep.prev_sh = s->vep.prev_sh;
2860 if (s->vep.lt_next != VCL_INVALID_SESSION_INDEX)
2861 vcl_epoll_lt_del (wrk, s);
2863 memset (&s->vep, 0, sizeof (s->vep));
2864 s->vep.next_sh = ~0;
2865 s->vep.prev_sh = ~0;
2867 s->vep.lt_next = VCL_INVALID_SESSION_INDEX;
2868 s->flags &= ~VCL_SESSION_F_IS_VEP_SESSION;
2870 if (vcl_session_is_open (s))
2872 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2874 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2877 VDBG (1, "EPOLL_CTL_DEL: vep_idx %u, sh %u!", vep_handle,
2879 vcl_evt (VCL_EVT_EPOLL_CTLDEL, s, vep_sh);
2883 VDBG (0, "Invalid operation (%d)!", op);
2887 vep_verify_epoll_chain (wrk, vep_handle);
2894 vcl_epoll_wait_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2895 struct epoll_event *events, u32 * num_ev)
2897 session_disconnected_msg_t *disconnected_msg;
2898 session_connected_msg_t *connected_msg;
2899 u32 sid = ~0, session_events;
2900 u64 session_evt_data = ~0;
2904 switch (e->event_type)
2906 case SESSION_IO_EVT_RX:
2907 sid = e->session_index;
2908 s = vcl_session_get (wrk, sid);
2909 if (vcl_session_is_closed (s))
2911 vcl_fifo_rx_evt_valid_or_break (s);
2912 session_events = s->vep.ev.events;
2913 if (!(EPOLLIN & s->vep.ev.events) ||
2914 (s->flags & VCL_SESSION_F_HAS_RX_EVT) ||
2915 (s->vep.lt_next != VCL_INVALID_SESSION_INDEX))
2918 events[*num_ev].events = EPOLLIN;
2919 session_evt_data = s->vep.ev.data.u64;
2920 s->flags |= VCL_SESSION_F_HAS_RX_EVT;
2922 case SESSION_IO_EVT_TX:
2923 sid = e->session_index;
2924 s = vcl_session_get (wrk, sid);
2925 if (vcl_session_is_closed (s))
2927 session_events = s->vep.ev.events;
2928 if (!(EPOLLOUT & session_events))
2931 events[*num_ev].events = EPOLLOUT;
2932 session_evt_data = s->vep.ev.data.u64;
2933 svm_fifo_reset_has_deq_ntf (vcl_session_is_ct (s) ?
2934 s->ct_tx_fifo : s->tx_fifo);
2936 case SESSION_CTRL_EVT_ACCEPTED:
2938 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
2940 s = vcl_session_get (wrk, e->session_index);
2943 session_events = s->vep.ev.events;
2944 sid = s->session_index;
2945 if (!(EPOLLIN & session_events) ||
2946 (s->vep.lt_next != VCL_INVALID_SESSION_INDEX))
2949 events[*num_ev].events = EPOLLIN;
2950 session_evt_data = s->vep.ev.data.u64;
2952 case SESSION_CTRL_EVT_CONNECTED:
2955 connected_msg = (session_connected_msg_t *) e->data;
2956 sid = vcl_session_connected_handler (wrk, connected_msg);
2959 sid = e->session_index;
2960 s = vcl_session_get (wrk, sid);
2961 if (vcl_session_is_closed (s))
2963 session_events = s->vep.ev.events;
2964 /* Generate EPOLLOUT because there's no connected event */
2965 if (!(EPOLLOUT & session_events))
2968 events[*num_ev].events = EPOLLOUT;
2969 session_evt_data = s->vep.ev.data.u64;
2970 if (s->session_state == VCL_STATE_DETACHED)
2971 events[*num_ev].events |= EPOLLHUP;
2973 case SESSION_CTRL_EVT_DISCONNECTED:
2976 disconnected_msg = (session_disconnected_msg_t *) e->data;
2977 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
2981 s = vcl_session_get (wrk, e->session_index);
2983 if (vcl_session_is_closed (s) ||
2984 !(s->flags & VCL_SESSION_F_IS_VEP_SESSION))
2986 sid = s->session_index;
2987 session_events = s->vep.ev.events;
2989 if (EPOLLRDHUP & session_events)
2991 /* If app can distinguish between RDHUP and HUP,
2992 * we make finer control */
2993 events[*num_ev].events = EPOLLRDHUP;
2994 if (s->flags & VCL_SESSION_F_WR_SHUTDOWN)
2996 events[*num_ev].events |= EPOLLHUP;
3001 events[*num_ev].events = EPOLLHUP;
3003 session_evt_data = s->vep.ev.data.u64;
3006 case SESSION_CTRL_EVT_RESET:
3008 sid = vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
3010 sid = e->session_index;
3011 s = vcl_session_get (wrk, sid);
3012 if (vcl_session_is_closed (s) ||
3013 !(s->flags & VCL_SESSION_F_IS_VEP_SESSION))
3015 session_events = s->vep.ev.events;
3017 events[*num_ev].events = EPOLLHUP | EPOLLRDHUP;
3018 session_evt_data = s->vep.ev.data.u64;
3020 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
3021 vcl_session_unlisten_reply_handler (wrk, e->data);
3023 case SESSION_CTRL_EVT_MIGRATED:
3024 vcl_session_migrated_handler (wrk, e->data);
3026 case SESSION_CTRL_EVT_CLEANUP:
3027 vcl_session_cleanup_handler (wrk, e->data);
3029 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
3030 vcl_session_req_worker_update_handler (wrk, e->data);
3032 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
3033 vcl_session_worker_update_reply_handler (wrk, e->data);
3035 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
3036 vcl_session_app_add_segment_handler (wrk, e->data);
3038 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
3039 vcl_session_app_del_segment_handler (wrk, e->data);
3041 case SESSION_CTRL_EVT_APP_WRK_RPC:
3042 vcl_worker_rpc_handler (wrk, e->data);
3045 VDBG (0, "unhandled: %u", e->event_type);
3051 events[*num_ev].data.u64 = session_evt_data;
3052 if (EPOLLONESHOT & session_events)
3054 s = vcl_session_get (wrk, sid);
3055 s->vep.ev.events = 0;
3057 else if (!(EPOLLET & session_events))
3059 s = vcl_session_get (wrk, sid);
3060 if (s->vep.lt_next == VCL_INVALID_SESSION_INDEX)
3061 vcl_epoll_lt_add (wrk, s);
3068 vcl_epoll_wait_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
3069 struct epoll_event *events, u32 maxevents,
3070 double wait_for_time, u32 * num_ev)
3072 svm_msg_q_msg_t *msg;
3076 if (vec_len (wrk->mq_msg_vector) && svm_msg_q_is_empty (mq))
3077 goto handle_dequeued;
3079 if (svm_msg_q_is_empty (mq))
3083 else if (wait_for_time < 0)
3084 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
3087 if (svm_msg_q_timedwait (mq, wait_for_time / 1e3))
3091 ASSERT (maxevents > *num_ev);
3092 vcl_mq_dequeue_batch (wrk, mq, ~0);
3095 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
3097 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
3098 e = svm_msg_q_msg_data (mq, msg);
3099 if (*num_ev < maxevents)
3100 vcl_epoll_wait_handle_mq_event (wrk, e, events, num_ev);
3102 vcl_handle_mq_event (wrk, e);
3103 svm_msg_q_free_msg (mq, msg);
3105 vec_reset_length (wrk->mq_msg_vector);
3106 vcl_handle_pending_wrk_updates (wrk);
3111 vppcom_epoll_wait_condvar (vcl_worker_t *wrk, struct epoll_event *events,
3112 int maxevents, u32 n_evts, double timeout_ms)
3119 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3124 vcl_epoll_wait_handle_mq (wrk, wrk->app_event_queue, events, maxevents,
3125 timeout_ms, &n_evts);
3126 if (n_evts || !timeout_ms)
3129 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3135 vppcom_epoll_wait_eventfd (vcl_worker_t *wrk, struct epoll_event *events,
3136 int maxevents, u32 n_evts, double timeout_ms)
3138 int __clib_unused n_read;
3139 vcl_mq_evt_conn_t *mqc;
3144 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
3148 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3153 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
3154 vec_len (wrk->mq_events), timeout_ms);
3157 VDBG (0, "epoll_wait error %u", errno);
3161 for (i = 0; i < n_mq_evts; i++)
3163 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
3164 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
3165 vcl_epoll_wait_handle_mq (wrk, mqc->mq, events, maxevents, 0,
3169 if (n_evts || !timeout_ms)
3172 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3178 vcl_epoll_wait_handle_lt (vcl_worker_t *wrk, struct epoll_event *events,
3179 int maxevents, u32 *n_evts)
3181 u32 add_event = 0, next;
3186 ASSERT (wrk->ep_lt_current != VCL_INVALID_SESSION_INDEX);
3187 if (*n_evts >= maxevents)
3190 next = wrk->ep_lt_current;
3193 s = vcl_session_get (wrk, next);
3194 next = s->vep.lt_next;
3196 if ((s->vep.ev.events & EPOLLIN) && (rv = vcl_session_read_ready (s)))
3199 events[*n_evts].events |= rv > 0 ? EPOLLIN : EPOLLHUP | EPOLLRDHUP;
3200 evt_data = s->vep.ev.data.u64;
3202 if ((s->vep.ev.events & EPOLLOUT) && (rv = vcl_session_write_ready (s)))
3205 events[*n_evts].events |= rv > 0 ? EPOLLOUT : EPOLLHUP | EPOLLRDHUP;
3206 evt_data = s->vep.ev.data.u64;
3208 if (!add_event && s->session_state > VCL_STATE_READY)
3211 events[*n_evts].events |= EPOLLHUP | EPOLLRDHUP;
3212 evt_data = s->vep.ev.data.u64;
3216 events[*n_evts].data.u64 = evt_data;
3219 if (EPOLLONESHOT & s->vep.ev.events)
3220 s->vep.ev.events = 0;
3221 if (*n_evts == maxevents)
3223 wrk->ep_lt_current = next;
3229 vcl_epoll_lt_del (wrk, s);
3230 if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX)
3234 while (next != wrk->ep_lt_current);
3238 vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
3239 int maxevents, double wait_for_time)
3241 vcl_worker_t *wrk = vcl_worker_get_current ();
3242 vcl_session_t *vep_session;
3246 if (PREDICT_FALSE (maxevents <= 0))
3248 VDBG (0, "ERROR: Invalid maxevents (%d)!", maxevents);
3249 return VPPCOM_EINVAL;
3252 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
3254 return VPPCOM_EBADFD;
3256 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
3258 VDBG (0, "ERROR: vep_idx (%u) is not a vep!", vep_handle);
3259 return VPPCOM_EINVAL;
3262 if (vec_len (wrk->unhandled_evts_vector))
3264 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
3266 vcl_epoll_wait_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i],
3268 if (n_evts == maxevents)
3270 vec_delete (wrk->unhandled_evts_vector, i + 1, 0);
3274 vec_reset_length (wrk->unhandled_evts_vector);
3277 if (PREDICT_FALSE (wrk->ep_lt_current != VCL_INVALID_SESSION_INDEX))
3278 vcl_epoll_wait_handle_lt (wrk, events, maxevents, &n_evts);
3280 /* Request to only drain unhandled */
3281 if ((int) wait_for_time == -2)
3285 if (vcm->cfg.use_mq_eventfd)
3286 n_evts = vppcom_epoll_wait_eventfd (wrk, events, maxevents, n_evts,
3289 n_evts = vppcom_epoll_wait_condvar (wrk, events, maxevents, n_evts,
3296 vppcom_session_attr (uint32_t session_handle, uint32_t op,
3297 void *buffer, uint32_t * buflen)
3299 vcl_worker_t *wrk = vcl_worker_get_current ();
3300 u32 *flags = buffer;
3301 vppcom_endpt_t *ep = buffer;
3302 transport_endpt_attr_t tea;
3303 vcl_session_t *session;
3306 session = vcl_session_get_w_handle (wrk, session_handle);
3308 return VPPCOM_EBADFD;
3312 case VPPCOM_ATTR_GET_NREAD:
3313 rv = vcl_session_read_ready (session);
3314 VDBG (2, "VPPCOM_ATTR_GET_NREAD: sh %u, nread = %d", session_handle,
3318 case VPPCOM_ATTR_GET_NWRITE:
3319 rv = vcl_session_write_ready (session);
3320 VDBG (2, "VPPCOM_ATTR_GET_NWRITE: sh %u, nwrite = %d", session_handle,
3324 case VPPCOM_ATTR_GET_FLAGS:
3325 if (PREDICT_TRUE (buffer && buflen && (*buflen >= sizeof (*flags))))
3329 (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK) ?
3331 *buflen = sizeof (*flags);
3332 VDBG (2, "VPPCOM_ATTR_GET_FLAGS: sh %u, flags = 0x%08x, "
3333 "is_nonblocking = %u", session_handle, *flags,
3334 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3340 case VPPCOM_ATTR_SET_FLAGS:
3341 if (PREDICT_TRUE (buffer && buflen && (*buflen == sizeof (*flags))))
3343 if (*flags & O_NONBLOCK)
3344 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
3346 vcl_session_clear_attr (session, VCL_SESS_ATTR_NONBLOCK);
3348 VDBG (2, "VPPCOM_ATTR_SET_FLAGS: sh %u, flags = 0x%08x,"
3349 " is_nonblocking = %u", session_handle, *flags,
3350 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3356 case VPPCOM_ATTR_GET_PEER_ADDR:
3357 if (PREDICT_TRUE (buffer && buflen &&
3358 (*buflen >= sizeof (*ep)) && ep->ip))
3360 ep->is_ip4 = session->transport.is_ip4;
3361 ep->port = session->transport.rmt_port;
3362 if (session->transport.is_ip4)
3363 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
3364 sizeof (ip4_address_t));
3366 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
3367 sizeof (ip6_address_t));
3368 *buflen = sizeof (*ep);
3370 "VPPCOM_ATTR_GET_PEER_ADDR: sh %u, is_ip4 = %u, "
3371 "addr = %U, port %u",
3372 session_handle, ep->is_ip4, vcl_format_ip46_address,
3373 &session->transport.rmt_ip,
3374 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3375 clib_net_to_host_u16 (ep->port));
3381 case VPPCOM_ATTR_GET_LCL_ADDR:
3382 if (PREDICT_TRUE (buffer && buflen &&
3383 (*buflen >= sizeof (*ep)) && ep->ip))
3385 ep->is_ip4 = session->transport.is_ip4;
3386 ep->port = session->transport.lcl_port;
3387 if (session->transport.is_ip4)
3388 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip4,
3389 sizeof (ip4_address_t));
3391 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip6,
3392 sizeof (ip6_address_t));
3393 *buflen = sizeof (*ep);
3395 "VPPCOM_ATTR_GET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3397 session_handle, ep->is_ip4, vcl_format_ip46_address,
3398 &session->transport.lcl_ip,
3399 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3400 clib_net_to_host_u16 (ep->port));
3406 case VPPCOM_ATTR_SET_LCL_ADDR:
3407 if (PREDICT_TRUE (buffer && buflen &&
3408 (*buflen >= sizeof (*ep)) && ep->ip))
3410 session->transport.is_ip4 = ep->is_ip4;
3411 session->transport.lcl_port = ep->port;
3412 vcl_ip_copy_from_ep (&session->transport.lcl_ip, ep);
3413 *buflen = sizeof (*ep);
3415 "VPPCOM_ATTR_SET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3417 session_handle, ep->is_ip4, vcl_format_ip46_address,
3418 &session->transport.lcl_ip,
3419 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3420 clib_net_to_host_u16 (ep->port));
3426 case VPPCOM_ATTR_GET_LIBC_EPFD:
3427 rv = session->libc_epfd;
3428 VDBG (2, "VPPCOM_ATTR_GET_LIBC_EPFD: libc_epfd %d", rv);
3431 case VPPCOM_ATTR_SET_LIBC_EPFD:
3432 if (PREDICT_TRUE (buffer && buflen &&
3433 (*buflen == sizeof (session->libc_epfd))))
3435 session->libc_epfd = *(int *) buffer;
3436 *buflen = sizeof (session->libc_epfd);
3438 VDBG (2, "VPPCOM_ATTR_SET_LIBC_EPFD: libc_epfd %d, buflen %d",
3439 session->libc_epfd, *buflen);
3445 case VPPCOM_ATTR_GET_PROTOCOL:
3446 if (buffer && buflen && (*buflen >= sizeof (int)))
3448 *(int *) buffer = session->session_type;
3449 *buflen = sizeof (int);
3451 VDBG (2, "VPPCOM_ATTR_GET_PROTOCOL: %d (%s), buflen %d",
3452 *(int *) buffer, *(int *) buffer ? "UDP" : "TCP", *buflen);
3458 case VPPCOM_ATTR_GET_LISTEN:
3459 if (buffer && buflen && (*buflen >= sizeof (int)))
3461 *(int *) buffer = vcl_session_has_attr (session,
3462 VCL_SESS_ATTR_LISTEN);
3463 *buflen = sizeof (int);
3465 VDBG (2, "VPPCOM_ATTR_GET_LISTEN: %d, buflen %d", *(int *) buffer,
3472 case VPPCOM_ATTR_GET_ERROR:
3473 if (buffer && buflen && (*buflen >= sizeof (int)))
3475 *(int *) buffer = 0;
3476 *buflen = sizeof (int);
3478 VDBG (2, "VPPCOM_ATTR_GET_ERROR: %d, buflen %d, #VPP-TBD#",
3479 *(int *) buffer, *buflen);
3485 case VPPCOM_ATTR_GET_TX_FIFO_LEN:
3486 if (buffer && buflen && (*buflen >= sizeof (u32)))
3490 *(size_t *) buffer = (session->sndbuf_size ? session->sndbuf_size :
3492 svm_fifo_size (session->tx_fifo) :
3493 vcm->cfg.tx_fifo_size);
3494 *buflen = sizeof (u32);
3496 VDBG (2, "VPPCOM_ATTR_GET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3497 " #VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer,
3504 case VPPCOM_ATTR_SET_DSCP:
3505 if (buffer && buflen && (*buflen >= sizeof (u8)))
3507 session->dscp = *(u8 *) buffer;
3509 VDBG (2, "VPPCOM_ATTR_SET_DSCP: %u (0x%x), buflen %d,",
3510 *(u8 *) buffer, *(u8 *) buffer, *buflen);
3516 case VPPCOM_ATTR_SET_TX_FIFO_LEN:
3517 if (buffer && buflen && (*buflen == sizeof (u32)))
3520 session->sndbuf_size = *(u32 *) buffer;
3521 VDBG (2, "VPPCOM_ATTR_SET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3522 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3529 case VPPCOM_ATTR_GET_RX_FIFO_LEN:
3530 if (buffer && buflen && (*buflen >= sizeof (u32)))
3534 *(size_t *) buffer = (session->rcvbuf_size ? session->rcvbuf_size :
3536 svm_fifo_size (session->rx_fifo) :
3537 vcm->cfg.rx_fifo_size);
3538 *buflen = sizeof (u32);
3540 VDBG (2, "VPPCOM_ATTR_GET_RX_FIFO_LEN: %u (0x%x), buflen %d, "
3541 "#VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer, *buflen);
3547 case VPPCOM_ATTR_SET_RX_FIFO_LEN:
3548 if (buffer && buflen && (*buflen == sizeof (u32)))
3551 session->rcvbuf_size = *(u32 *) buffer;
3552 VDBG (2, "VPPCOM_ATTR_SET_RX_FIFO_LEN: %u (0x%x), buflen %d,"
3553 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3560 case VPPCOM_ATTR_GET_REUSEADDR:
3561 if (buffer && buflen && (*buflen >= sizeof (int)))
3564 *(int *) buffer = vcl_session_has_attr (session,
3565 VCL_SESS_ATTR_REUSEADDR);
3566 *buflen = sizeof (int);
3568 VDBG (2, "VPPCOM_ATTR_GET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3569 *(int *) buffer, *buflen);
3575 case VPPCOM_ATTR_SET_REUSEADDR:
3576 if (buffer && buflen && (*buflen == sizeof (int)) &&
3577 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3580 if (*(int *) buffer)
3581 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEADDR);
3583 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEADDR);
3585 VDBG (2, "VPPCOM_ATTR_SET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3586 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEADDR),
3593 case VPPCOM_ATTR_GET_REUSEPORT:
3594 if (buffer && buflen && (*buflen >= sizeof (int)))
3597 *(int *) buffer = vcl_session_has_attr (session,
3598 VCL_SESS_ATTR_REUSEPORT);
3599 *buflen = sizeof (int);
3601 VDBG (2, "VPPCOM_ATTR_GET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3602 *(int *) buffer, *buflen);
3608 case VPPCOM_ATTR_SET_REUSEPORT:
3609 if (buffer && buflen && (*buflen == sizeof (int)) &&
3610 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3613 if (*(int *) buffer)
3614 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEPORT);
3616 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEPORT);
3618 VDBG (2, "VPPCOM_ATTR_SET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3619 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEPORT),
3626 case VPPCOM_ATTR_GET_BROADCAST:
3627 if (buffer && buflen && (*buflen >= sizeof (int)))
3630 *(int *) buffer = vcl_session_has_attr (session,
3631 VCL_SESS_ATTR_BROADCAST);
3632 *buflen = sizeof (int);
3634 VDBG (2, "VPPCOM_ATTR_GET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3635 *(int *) buffer, *buflen);
3641 case VPPCOM_ATTR_SET_BROADCAST:
3642 if (buffer && buflen && (*buflen == sizeof (int)))
3645 if (*(int *) buffer)
3646 vcl_session_set_attr (session, VCL_SESS_ATTR_BROADCAST);
3648 vcl_session_clear_attr (session, VCL_SESS_ATTR_BROADCAST);
3650 VDBG (2, "VPPCOM_ATTR_SET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3651 vcl_session_has_attr (session, VCL_SESS_ATTR_BROADCAST),
3658 case VPPCOM_ATTR_GET_V6ONLY:
3659 if (buffer && buflen && (*buflen >= sizeof (int)))
3662 *(int *) buffer = vcl_session_has_attr (session,
3663 VCL_SESS_ATTR_V6ONLY);
3664 *buflen = sizeof (int);
3666 VDBG (2, "VPPCOM_ATTR_GET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3667 *(int *) buffer, *buflen);
3673 case VPPCOM_ATTR_SET_V6ONLY:
3674 if (buffer && buflen && (*buflen == sizeof (int)))
3677 if (*(int *) buffer)
3678 vcl_session_set_attr (session, VCL_SESS_ATTR_V6ONLY);
3680 vcl_session_clear_attr (session, VCL_SESS_ATTR_V6ONLY);
3682 VDBG (2, "VPPCOM_ATTR_SET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3683 vcl_session_has_attr (session, VCL_SESS_ATTR_V6ONLY),
3690 case VPPCOM_ATTR_GET_KEEPALIVE:
3691 if (buffer && buflen && (*buflen >= sizeof (int)))
3694 *(int *) buffer = vcl_session_has_attr (session,
3695 VCL_SESS_ATTR_KEEPALIVE);
3696 *buflen = sizeof (int);
3698 VDBG (2, "VPPCOM_ATTR_GET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3699 *(int *) buffer, *buflen);
3705 case VPPCOM_ATTR_SET_KEEPALIVE:
3706 if (buffer && buflen && (*buflen == sizeof (int)))
3709 if (*(int *) buffer)
3710 vcl_session_set_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3712 vcl_session_clear_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3714 VDBG (2, "VPPCOM_ATTR_SET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3715 vcl_session_has_attr (session, VCL_SESS_ATTR_KEEPALIVE),
3722 case VPPCOM_ATTR_GET_TCP_NODELAY:
3723 if (buffer && buflen && (*buflen >= sizeof (int)))
3726 *(int *) buffer = vcl_session_has_attr (session,
3727 VCL_SESS_ATTR_TCP_NODELAY);
3728 *buflen = sizeof (int);
3730 VDBG (2, "VPPCOM_ATTR_GET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3731 *(int *) buffer, *buflen);
3737 case VPPCOM_ATTR_SET_TCP_NODELAY:
3738 if (buffer && buflen && (*buflen == sizeof (int)))
3741 if (*(int *) buffer)
3742 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3744 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3746 VDBG (2, "VPPCOM_ATTR_SET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3747 vcl_session_has_attr (session, VCL_SESS_ATTR_TCP_NODELAY),
3754 case VPPCOM_ATTR_GET_TCP_KEEPIDLE:
3755 if (buffer && buflen && (*buflen >= sizeof (int)))
3758 *(int *) buffer = vcl_session_has_attr (session,
3759 VCL_SESS_ATTR_TCP_KEEPIDLE);
3760 *buflen = sizeof (int);
3762 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3763 *(int *) buffer, *buflen);
3769 case VPPCOM_ATTR_SET_TCP_KEEPIDLE:
3770 if (buffer && buflen && (*buflen == sizeof (int)))
3773 if (*(int *) buffer)
3774 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3776 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3778 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3779 vcl_session_has_attr (session,
3780 VCL_SESS_ATTR_TCP_KEEPIDLE), *buflen);
3786 case VPPCOM_ATTR_GET_TCP_KEEPINTVL:
3787 if (buffer && buflen && (*buflen >= sizeof (int)))
3790 *(int *) buffer = vcl_session_has_attr (session,
3791 VCL_SESS_ATTR_TCP_KEEPINTVL);
3792 *buflen = sizeof (int);
3794 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3795 *(int *) buffer, *buflen);
3801 case VPPCOM_ATTR_SET_TCP_KEEPINTVL:
3802 if (buffer && buflen && (*buflen == sizeof (int)))
3805 if (*(int *) buffer)
3806 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3808 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3810 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3811 vcl_session_has_attr (session,
3812 VCL_SESS_ATTR_TCP_KEEPINTVL), *buflen);
3818 case VPPCOM_ATTR_GET_TCP_USER_MSS:
3819 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
3825 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3826 tea.mss = *(u32 *) buffer;
3827 if (vcl_session_transport_attr (wrk, session, 1 /* is_get */, &tea))
3828 rv = VPPCOM_ENOPROTOOPT;
3832 *(u32 *) buffer = tea.mss;
3833 *buflen = sizeof (int);
3836 VDBG (2, "VPPCOM_ATTR_GET_TCP_USER_MSS: %d, buflen %d", *(int *) buffer,
3840 case VPPCOM_ATTR_SET_TCP_USER_MSS:
3841 if (!(buffer && buflen && (*buflen == sizeof (u32))))
3847 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3848 tea.mss = *(u32 *) buffer;
3849 if (vcl_session_transport_attr (wrk, session, 0 /* is_get */, &tea))
3850 rv = VPPCOM_ENOPROTOOPT;
3852 VDBG (2, "VPPCOM_ATTR_SET_TCP_USER_MSS: %u, buflen %d", tea.mss,
3856 case VPPCOM_ATTR_SET_CONNECTED:
3857 session->flags |= VCL_SESSION_F_CONNECTED;
3860 case VPPCOM_ATTR_SET_CKPAIR:
3861 if (!(buffer && buflen && (*buflen == sizeof (int))) ||
3862 !vcl_session_has_crypto (session))
3867 if (!session->ext_config)
3869 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_CRYPTO,
3870 sizeof (transport_endpt_ext_cfg_t));
3872 else if (session->ext_config->type != TRANSPORT_ENDPT_EXT_CFG_CRYPTO)
3878 session->ext_config->crypto.ckpair_index = *(uint32_t *) buffer;
3881 case VPPCOM_ATTR_SET_VRF:
3882 if (!(buffer && buflen && (*buflen == sizeof (u32))))
3887 session->vrf = *(u32 *) buffer;
3890 case VPPCOM_ATTR_GET_VRF:
3891 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
3896 *(u32 *) buffer = session->vrf;
3897 *buflen = sizeof (u32);
3900 case VPPCOM_ATTR_GET_DOMAIN:
3901 if (!(buffer && buflen && (*buflen >= sizeof (int))))
3907 if (session->transport.is_ip4)
3908 *(int *) buffer = AF_INET;
3910 *(int *) buffer = AF_INET6;
3911 *buflen = sizeof (int);
3913 VDBG (2, "VPPCOM_ATTR_GET_DOMAIN: %d, buflen %u", *(int *) buffer,
3917 case VPPCOM_ATTR_SET_ENDPT_EXT_CFG:
3918 if (!(buffer && buflen && (*buflen > 0)))
3923 if (session->ext_config)
3928 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_NONE,
3929 *buflen + sizeof (u32));
3930 clib_memcpy (session->ext_config->data, buffer, *buflen);
3931 session->ext_config->len = *buflen;
3943 vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
3944 uint32_t buflen, int flags, vppcom_endpt_t * ep)
3946 vcl_worker_t *wrk = vcl_worker_get_current ();
3947 vcl_session_t *session;
3951 rv = vppcom_session_read (session_handle, buffer, buflen);
3952 else if (flags & MSG_PEEK)
3953 rv = vppcom_session_peek (session_handle, buffer, buflen);
3956 VDBG (0, "Unsupport flags for recvfrom %d", flags);
3957 return VPPCOM_EAFNOSUPPORT;
3962 session = vcl_session_get_w_handle (wrk, session_handle);
3963 if (session->transport.is_ip4)
3964 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
3965 sizeof (ip4_address_t));
3967 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
3968 sizeof (ip6_address_t));
3969 ep->is_ip4 = session->transport.is_ip4;
3970 ep->port = session->transport.rmt_port;
3977 vppcom_session_sendto (uint32_t session_handle, void *buffer,
3978 uint32_t buflen, int flags, vppcom_endpt_t * ep)
3980 vcl_worker_t *wrk = vcl_worker_get_current ();
3983 s = vcl_session_get_w_handle (wrk, session_handle);
3984 if (PREDICT_FALSE (!s))
3985 return VPPCOM_EBADFD;
3989 if (!vcl_session_is_cl (s))
3990 return VPPCOM_EINVAL;
3992 s->transport.is_ip4 = ep->is_ip4;
3993 s->transport.rmt_port = ep->port;
3994 vcl_ip_copy_from_ep (&s->transport.rmt_ip, ep);
3996 /* Session not connected/bound in vpp. Create it by 'connecting' it */
3997 if (PREDICT_FALSE (s->session_state == VCL_STATE_CLOSED))
3999 u32 session_index = s->session_index;
4000 f64 timeout = vcm->cfg.session_timeout;
4003 vcl_send_session_connect (wrk, s);
4004 rv = vppcom_wait_for_session_state_change (session_index,
4009 s = vcl_session_get (wrk, session_index);
4015 // TBD check the flags and do the right thing
4016 VDBG (2, "handling flags 0x%u (%d) not implemented yet.", flags, flags);
4019 return (vppcom_session_write_inline (wrk, s, buffer, buflen, 1,
4020 s->is_dgram ? 1 : 0));
4024 vppcom_poll (vcl_poll_t * vp, uint32_t n_sids, double wait_for_time)
4026 vcl_worker_t *wrk = vcl_worker_get_current ();
4027 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
4028 u32 i, keep_trying = 1;
4029 svm_msg_q_msg_t msg;
4033 VDBG (3, "vp %p, nsids %u, wait_for_time %f", vp, n_sids, wait_for_time);
4036 return VPPCOM_EFAULT;
4040 vcl_session_t *session;
4042 /* Dequeue all events and drop all unhandled io events */
4043 while (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0) == 0)
4045 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
4046 vcl_handle_mq_event (wrk, e);
4047 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
4049 vec_reset_length (wrk->unhandled_evts_vector);
4051 for (i = 0; i < n_sids; i++)
4053 session = vcl_session_get (wrk, vp[i].sh);
4056 vp[i].revents = POLLHUP;
4063 if (POLLIN & vp[i].events)
4065 rv = vcl_session_read_ready (session);
4068 vp[i].revents |= POLLIN;
4075 case VPPCOM_ECONNRESET:
4076 vp[i].revents = POLLHUP;
4080 vp[i].revents = POLLERR;
4087 if (POLLOUT & vp[i].events)
4089 rv = vcl_session_write_ready (session);
4092 vp[i].revents |= POLLOUT;
4099 case VPPCOM_ECONNRESET:
4100 vp[i].revents = POLLHUP;
4104 vp[i].revents = POLLERR;
4111 if (0) // Note "done:" label used by VCL_SESSION_LOCK_AND_GET()
4113 vp[i].revents = POLLNVAL;
4117 if (wait_for_time != -1)
4118 keep_trying = (clib_time_now (&wrk->clib_time) <= timeout) ? 1 : 0;
4120 while ((num_ev == 0) && keep_trying);
4126 vppcom_mq_epoll_fd (void)
4128 vcl_worker_t *wrk = vcl_worker_get_current ();
4129 return wrk->mqs_epfd;
4133 vppcom_session_index (vcl_session_handle_t session_handle)
4135 return session_handle & 0xFFFFFF;
4139 vppcom_session_worker (vcl_session_handle_t session_handle)
4141 return session_handle >> 24;
4145 vppcom_worker_register (void)
4147 if (!vcl_worker_alloc_and_init ())
4148 return VPPCOM_EEXIST;
4150 if (vcl_worker_register_with_vpp ())
4151 return VPPCOM_EEXIST;
4157 vppcom_worker_unregister (void)
4159 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
4160 vcl_set_worker_index (~0);
4164 vppcom_worker_index_set (int index)
4166 vcl_set_worker_index (index);
4170 vppcom_worker_index (void)
4172 return vcl_get_worker_index ();
4176 vppcom_worker_mqs_epfd (void)
4178 vcl_worker_t *wrk = vcl_worker_get_current ();
4179 if (!vcm->cfg.use_mq_eventfd)
4181 return wrk->mqs_epfd;
4185 vppcom_session_is_connectable_listener (uint32_t session_handle)
4187 vcl_session_t *session;
4188 vcl_worker_t *wrk = vcl_worker_get_current ();
4189 session = vcl_session_get_w_handle (wrk, session_handle);
4191 return VPPCOM_EBADFD;
4192 return vcl_session_is_connectable_listener (wrk, session);
4196 vppcom_session_listener (uint32_t session_handle)
4198 vcl_worker_t *wrk = vcl_worker_get_current ();
4199 vcl_session_t *listen_session, *session;
4200 session = vcl_session_get_w_handle (wrk, session_handle);
4202 return VPPCOM_EBADFD;
4203 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
4204 return VPPCOM_EBADFD;
4205 listen_session = vcl_session_get_w_handle (wrk, session->listener_index);
4206 if (!listen_session)
4207 return VPPCOM_EBADFD;
4208 return vcl_session_handle (listen_session);
4212 vppcom_session_n_accepted (uint32_t session_handle)
4214 vcl_worker_t *wrk = vcl_worker_get_current ();
4215 vcl_session_t *session = vcl_session_get_w_handle (wrk, session_handle);
4217 return VPPCOM_EBADFD;
4218 return session->n_accepted_sessions;
4222 vppcom_proto_str (vppcom_proto_t proto)
4224 char const *proto_str;
4228 case VPPCOM_PROTO_TCP:
4231 case VPPCOM_PROTO_UDP:
4234 case VPPCOM_PROTO_TLS:
4237 case VPPCOM_PROTO_QUIC:
4240 case VPPCOM_PROTO_DTLS:
4243 case VPPCOM_PROTO_SRTP:
4247 proto_str = "UNKNOWN";
4254 vppcom_retval_str (int retval)
4265 st = "VPPCOM_EAGAIN";
4269 st = "VPPCOM_EFAULT";
4273 st = "VPPCOM_ENOMEM";
4277 st = "VPPCOM_EINVAL";
4281 st = "VPPCOM_EBADFD";
4284 case VPPCOM_EAFNOSUPPORT:
4285 st = "VPPCOM_EAFNOSUPPORT";
4288 case VPPCOM_ECONNABORTED:
4289 st = "VPPCOM_ECONNABORTED";
4292 case VPPCOM_ECONNRESET:
4293 st = "VPPCOM_ECONNRESET";
4296 case VPPCOM_ENOTCONN:
4297 st = "VPPCOM_ENOTCONN";
4300 case VPPCOM_ECONNREFUSED:
4301 st = "VPPCOM_ECONNREFUSED";
4304 case VPPCOM_ETIMEDOUT:
4305 st = "VPPCOM_ETIMEDOUT";
4309 st = "UNKNOWN_STATE";
4317 vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
4319 if (vcm->cfg.vpp_app_socket_api)
4320 return vcl_sapi_add_cert_key_pair (ckpair);
4322 return vcl_bapi_add_cert_key_pair (ckpair);
4326 vppcom_del_cert_key_pair (uint32_t ckpair_index)
4328 if (vcm->cfg.vpp_app_socket_api)
4329 return vcl_sapi_del_cert_key_pair (ckpair_index);
4331 return vcl_bapi_del_cert_key_pair (ckpair_index);
4335 * fd.io coding-style-patch-verification: ON
4338 * eval: (c-set-style "gnu")