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);
41 vppcom_session_state_str (vcl_session_state_t state)
47 case VCL_STATE_CLOSED:
50 case VCL_STATE_LISTEN:
56 case VCL_STATE_VPP_CLOSING:
57 st = "STATE_VPP_CLOSING";
59 case VCL_STATE_DISCONNECT:
60 st = "STATE_DISCONNECT";
62 case VCL_STATE_DETACHED:
63 st = "STATE_DETACHED";
65 case VCL_STATE_UPDATED:
68 case VCL_STATE_LISTEN_NO_MQ:
69 st = "STATE_LISTEN_NO_MQ";
80 format_ip4_address (u8 * s, va_list * args)
82 u8 *a = va_arg (*args, u8 *);
83 return format (s, "%d.%d.%d.%d", a[0], a[1], a[2], a[3]);
87 format_ip6_address (u8 * s, va_list * args)
89 ip6_address_t *a = va_arg (*args, ip6_address_t *);
90 u32 i, i_max_n_zero, max_n_zeros, i_first_zero, n_zeros, last_double_colon;
92 i_max_n_zero = ARRAY_LEN (a->as_u16);
94 i_first_zero = i_max_n_zero;
96 for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
98 u32 is_zero = a->as_u16[i] == 0;
99 if (is_zero && i_first_zero >= ARRAY_LEN (a->as_u16))
105 if ((!is_zero && n_zeros > max_n_zeros)
106 || (i + 1 >= ARRAY_LEN (a->as_u16) && n_zeros > max_n_zeros))
108 i_max_n_zero = i_first_zero;
109 max_n_zeros = n_zeros;
110 i_first_zero = ARRAY_LEN (a->as_u16);
115 last_double_colon = 0;
116 for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
118 if (i == i_max_n_zero && max_n_zeros > 1)
120 s = format (s, "::");
121 i += max_n_zeros - 1;
122 last_double_colon = 1;
126 s = format (s, "%s%x",
127 (last_double_colon || i == 0) ? "" : ":",
128 clib_net_to_host_u16 (a->as_u16[i]));
129 last_double_colon = 0;
136 /* Format an IP46 address. */
138 format_ip46_address (u8 * s, va_list * args)
140 ip46_address_t *ip46 = va_arg (*args, ip46_address_t *);
141 ip46_type_t type = va_arg (*args, ip46_type_t);
147 is_ip4 = ip46_address_is_ip4 (ip46);
158 format (s, "%U", format_ip4_address, &ip46->ip4) :
159 format (s, "%U", format_ip6_address, &ip46->ip6);
163 * VPPCOM Utility Functions
167 vcl_msg_add_ext_config (vcl_session_t *s, uword *offset)
171 c = vcl_segment_alloc_chunk (vcl_vpp_worker_segment_handle (0),
172 0 /* one slice only */, s->ext_config->len,
175 clib_memcpy_fast (c->data, s->ext_config, s->ext_config->len);
179 vcl_send_session_listen (vcl_worker_t * wrk, vcl_session_t * s)
181 app_session_evt_t _app_evt, *app_evt = &_app_evt;
182 session_listen_msg_t *mp;
185 mq = vcl_worker_ctrl_mq (wrk);
186 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_LISTEN);
187 mp = (session_listen_msg_t *) app_evt->evt->data;
188 memset (mp, 0, sizeof (*mp));
189 mp->client_index = wrk->api_client_handle;
190 mp->context = s->session_index;
191 mp->wrk_index = wrk->vpp_wrk_index;
192 mp->is_ip4 = s->transport.is_ip4;
193 clib_memcpy_fast (&mp->ip, &s->transport.lcl_ip, sizeof (mp->ip));
194 mp->port = s->transport.lcl_port;
195 mp->proto = s->session_type;
197 if (s->flags & VCL_SESSION_F_CONNECTED)
198 mp->flags = TRANSPORT_CFG_F_CONNECTED;
200 vcl_msg_add_ext_config (s, &mp->ext_config);
201 app_send_ctrl_evt_to_vpp (mq, app_evt);
204 clib_mem_free (s->ext_config);
210 vcl_send_session_connect (vcl_worker_t * wrk, vcl_session_t * s)
212 app_session_evt_t _app_evt, *app_evt = &_app_evt;
213 session_connect_msg_t *mp;
216 mq = vcl_worker_ctrl_mq (wrk);
217 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_CONNECT);
218 mp = (session_connect_msg_t *) app_evt->evt->data;
219 memset (mp, 0, sizeof (*mp));
220 mp->client_index = wrk->api_client_handle;
221 mp->context = s->session_index;
222 mp->wrk_index = wrk->vpp_wrk_index;
223 mp->is_ip4 = s->transport.is_ip4;
224 mp->parent_handle = s->parent_handle;
225 clib_memcpy_fast (&mp->ip, &s->transport.rmt_ip, sizeof (mp->ip));
226 clib_memcpy_fast (&mp->lcl_ip, &s->transport.lcl_ip, sizeof (mp->lcl_ip));
227 mp->port = s->transport.rmt_port;
228 mp->lcl_port = s->transport.lcl_port;
229 mp->proto = s->session_type;
231 if (s->flags & VCL_SESSION_F_CONNECTED)
232 mp->flags |= TRANSPORT_CFG_F_CONNECTED;
234 vcl_msg_add_ext_config (s, &mp->ext_config);
235 app_send_ctrl_evt_to_vpp (mq, app_evt);
239 clib_mem_free (s->ext_config);
245 vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s)
247 app_session_evt_t _app_evt, *app_evt = &_app_evt;
248 session_unlisten_msg_t *mp;
251 mq = vcl_worker_ctrl_mq (wrk);
252 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_UNLISTEN);
253 mp = (session_unlisten_msg_t *) app_evt->evt->data;
254 memset (mp, 0, sizeof (*mp));
255 mp->client_index = wrk->api_client_handle;
256 mp->wrk_index = wrk->vpp_wrk_index;
257 mp->handle = s->vpp_handle;
258 mp->context = wrk->wrk_index;
259 app_send_ctrl_evt_to_vpp (mq, app_evt);
263 vcl_send_session_shutdown (vcl_worker_t *wrk, vcl_session_t *s)
265 app_session_evt_t _app_evt, *app_evt = &_app_evt;
266 session_shutdown_msg_t *mp;
269 /* Send to thread that owns the session */
271 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_SHUTDOWN);
272 mp = (session_shutdown_msg_t *) app_evt->evt->data;
273 memset (mp, 0, sizeof (*mp));
274 mp->client_index = wrk->api_client_handle;
275 mp->handle = s->vpp_handle;
276 app_send_ctrl_evt_to_vpp (mq, app_evt);
280 vcl_send_session_disconnect (vcl_worker_t * wrk, vcl_session_t * s)
282 app_session_evt_t _app_evt, *app_evt = &_app_evt;
283 session_disconnect_msg_t *mp;
286 /* Send to thread that owns the session */
288 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_DISCONNECT);
289 mp = (session_disconnect_msg_t *) app_evt->evt->data;
290 memset (mp, 0, sizeof (*mp));
291 mp->client_index = wrk->api_client_handle;
292 mp->handle = s->vpp_handle;
293 app_send_ctrl_evt_to_vpp (mq, app_evt);
297 vcl_send_app_detach (vcl_worker_t * wrk)
299 app_session_evt_t _app_evt, *app_evt = &_app_evt;
300 session_app_detach_msg_t *mp;
303 mq = vcl_worker_ctrl_mq (wrk);
304 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_DETACH);
305 mp = (session_app_detach_msg_t *) app_evt->evt->data;
306 memset (mp, 0, sizeof (*mp));
307 mp->client_index = wrk->api_client_handle;
308 app_send_ctrl_evt_to_vpp (mq, app_evt);
312 vcl_send_session_accepted_reply (svm_msg_q_t * mq, u32 context,
313 session_handle_t handle, int retval)
315 app_session_evt_t _app_evt, *app_evt = &_app_evt;
316 session_accepted_reply_msg_t *rmp;
317 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_ACCEPTED_REPLY);
318 rmp = (session_accepted_reply_msg_t *) app_evt->evt->data;
319 rmp->handle = handle;
320 rmp->context = context;
321 rmp->retval = retval;
322 app_send_ctrl_evt_to_vpp (mq, app_evt);
326 vcl_send_session_disconnected_reply (vcl_worker_t * wrk, vcl_session_t * s,
329 app_session_evt_t _app_evt, *app_evt = &_app_evt;
330 session_disconnected_reply_msg_t *rmp;
331 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
332 SESSION_CTRL_EVT_DISCONNECTED_REPLY);
333 rmp = (session_disconnected_reply_msg_t *) app_evt->evt->data;
334 rmp->handle = s->vpp_handle;
335 rmp->context = wrk->api_client_handle;
336 rmp->retval = retval;
337 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
341 vcl_send_session_reset_reply (vcl_worker_t * wrk, vcl_session_t * s,
344 app_session_evt_t _app_evt, *app_evt = &_app_evt;
345 session_reset_reply_msg_t *rmp;
346 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
347 SESSION_CTRL_EVT_RESET_REPLY);
348 rmp = (session_reset_reply_msg_t *) app_evt->evt->data;
349 rmp->handle = s->vpp_handle;
350 rmp->context = wrk->api_client_handle;
351 rmp->retval = retval;
352 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
356 vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s,
359 app_session_evt_t _app_evt, *app_evt = &_app_evt;
360 session_worker_update_msg_t *mp;
362 app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt,
363 SESSION_CTRL_EVT_WORKER_UPDATE);
364 mp = (session_worker_update_msg_t *) app_evt->evt->data;
365 mp->client_index = wrk->api_client_handle;
366 mp->handle = s->vpp_handle;
367 mp->req_wrk_index = wrk->vpp_wrk_index;
368 mp->wrk_index = wrk_index;
369 app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt);
373 vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len)
375 app_session_evt_t _app_evt, *app_evt = &_app_evt;
376 session_app_wrk_rpc_msg_t *mp;
377 vcl_worker_t *dst_wrk, *wrk;
381 if (data_len > sizeof (mp->data))
384 clib_spinlock_lock (&vcm->workers_lock);
386 dst_wrk = vcl_worker_get_if_valid (dst_wrk_index);
390 wrk = vcl_worker_get_current ();
391 mq = vcl_worker_ctrl_mq (wrk);
392 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_WRK_RPC);
393 mp = (session_app_wrk_rpc_msg_t *) app_evt->evt->data;
394 mp->client_index = wrk->api_client_handle;
395 mp->wrk_index = dst_wrk->vpp_wrk_index;
396 clib_memcpy (mp->data, data, data_len);
397 app_send_ctrl_evt_to_vpp (mq, app_evt);
401 clib_spinlock_unlock (&vcm->workers_lock);
406 vcl_session_transport_attr (vcl_worker_t *wrk, vcl_session_t *s, u8 is_get,
407 transport_endpt_attr_t *attr)
409 app_session_evt_t _app_evt, *app_evt = &_app_evt;
410 session_transport_attr_msg_t *mp;
414 ASSERT (!wrk->session_attr_op);
415 wrk->session_attr_op = 1;
416 wrk->session_attr_op_rv = -1;
419 app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_TRANSPORT_ATTR);
420 mp = (session_transport_attr_msg_t *) app_evt->evt->data;
421 memset (mp, 0, sizeof (*mp));
422 mp->client_index = wrk->api_client_handle;
423 mp->handle = s->vpp_handle;
426 app_send_ctrl_evt_to_vpp (mq, app_evt);
428 timeout = clib_time_now (&wrk->clib_time) + 1;
430 while (wrk->session_attr_op && clib_time_now (&wrk->clib_time) < timeout)
431 vcl_flush_mq_events ();
433 if (!wrk->session_attr_op_rv && is_get)
434 *attr = wrk->session_attr_rv;
436 wrk->session_attr_op = 0;
438 return wrk->session_attr_op_rv;
442 vcl_session_accepted_handler (vcl_worker_t * wrk, session_accepted_msg_t * mp,
445 vcl_session_t *session, *listen_session;
448 session = vcl_session_alloc (wrk);
450 listen_session = vcl_session_get (wrk, ls_index);
451 if (listen_session->vpp_handle != mp->listener_handle)
453 VDBG (0, "ERROR: listener handle %lu does not match session %u",
454 mp->listener_handle, ls_index);
458 if (vcl_segment_attach_session (mp->segment_handle, mp->server_rx_fifo,
460 mp->vpp_event_queue_address, 0, session))
462 VDBG (0, "failed to attach fifos for %u", session->session_index);
466 session->vpp_handle = mp->handle;
467 session->session_state = VCL_STATE_READY;
468 session->transport.rmt_port = mp->rmt.port;
469 session->transport.is_ip4 = mp->rmt.is_ip4;
470 clib_memcpy_fast (&session->transport.rmt_ip, &mp->rmt.ip,
471 sizeof (ip46_address_t));
473 vcl_session_table_add_vpp_handle (wrk, mp->handle, session->session_index);
474 session->transport.lcl_port = mp->lcl.port;
475 session->transport.lcl_ip = mp->lcl.ip;
476 session->session_type = listen_session->session_type;
477 session->is_dgram = vcl_proto_is_dgram (session->session_type);
478 session->listener_index = listen_session->session_index;
479 listen_session->n_accepted_sessions++;
481 VDBG (1, "session %u [0x%llx]: client accept request from %s address %U"
482 " port %d queue %p!", session->session_index, mp->handle,
483 mp->rmt.is_ip4 ? "IPv4" : "IPv6", format_ip46_address, &mp->rmt.ip,
484 mp->rmt.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
485 clib_net_to_host_u16 (mp->rmt.port), session->vpp_evt_q);
486 vcl_evt (VCL_EVT_ACCEPT, session, listen_session, session_index);
488 vcl_send_session_accepted_reply (session->vpp_evt_q, mp->context,
489 session->vpp_handle, 0);
491 return session->session_index;
494 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0),
495 mp->vpp_event_queue_address, mp->mq_index, &evt_q);
496 vcl_send_session_accepted_reply (evt_q, mp->context, mp->handle,
497 VNET_API_ERROR_INVALID_ARGUMENT);
498 vcl_session_free (wrk, session);
499 return VCL_INVALID_SESSION_INDEX;
503 vcl_session_connected_handler (vcl_worker_t * wrk,
504 session_connected_msg_t * mp)
506 vcl_session_t *session = 0;
509 session_index = mp->context;
510 session = vcl_session_get (wrk, session_index);
513 VDBG (0, "ERROR: vpp handle 0x%llx has no session index (%u)!",
514 mp->handle, session_index);
515 return VCL_INVALID_SESSION_INDEX;
519 VDBG (0, "ERROR: session index %u: connect failed! %U",
520 session_index, format_session_error, mp->retval);
521 session->session_state = VCL_STATE_DETACHED;
522 session->vpp_handle = mp->handle;
523 return session_index;
526 session->vpp_handle = mp->handle;
528 if (vcl_segment_attach_session (mp->segment_handle, mp->server_rx_fifo,
530 mp->vpp_event_queue_address, 0, session))
532 VDBG (0, "failed to attach fifos for %u", session->session_index);
533 session->session_state = VCL_STATE_DETACHED;
534 vcl_send_session_disconnect (wrk, session);
535 return session_index;
540 if (vcl_segment_attach_session (mp->ct_segment_handle, mp->ct_rx_fifo,
541 mp->ct_tx_fifo, (uword) ~0, 1, session))
543 VDBG (0, "failed to attach ct fifos for %u", session->session_index);
544 session->session_state = VCL_STATE_DETACHED;
545 vcl_send_session_disconnect (wrk, session);
546 return session_index;
550 session->transport.is_ip4 = mp->lcl.is_ip4;
551 clib_memcpy_fast (&session->transport.lcl_ip, &mp->lcl.ip,
552 sizeof (session->transport.lcl_ip));
553 session->transport.lcl_port = mp->lcl.port;
555 /* Application closed session before connect reply */
556 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK)
557 && session->session_state == VCL_STATE_CLOSED)
558 vcl_send_session_disconnect (wrk, session);
560 session->session_state = VCL_STATE_READY;
562 /* Add it to lookup table */
563 vcl_session_table_add_vpp_handle (wrk, mp->handle, session_index);
565 VDBG (1, "session %u [0x%llx] connected! rx_fifo %p, refcnt %d, tx_fifo %p,"
566 " refcnt %d", session_index, mp->handle, session->rx_fifo,
567 session->rx_fifo->refcnt, session->tx_fifo, session->tx_fifo->refcnt);
569 return session_index;
573 vcl_flag_accepted_session (vcl_session_t * session, u64 handle, u32 flags)
575 vcl_session_msg_t *accepted_msg;
578 for (i = 0; i < vec_len (session->accept_evts_fifo); i++)
580 accepted_msg = &session->accept_evts_fifo[i];
581 if (accepted_msg->accepted_msg.handle == handle)
583 accepted_msg->flags |= flags;
591 vcl_session_reset_handler (vcl_worker_t * wrk,
592 session_reset_msg_t * reset_msg)
594 vcl_session_t *session;
597 sid = vcl_session_index_from_vpp_handle (wrk, reset_msg->handle);
598 session = vcl_session_get (wrk, sid);
601 VDBG (0, "request to reset unknown handle 0x%llx", reset_msg->handle);
602 return VCL_INVALID_SESSION_INDEX;
605 /* Caught a reset before actually accepting the session */
606 if (session->session_state == VCL_STATE_LISTEN)
609 if (!vcl_flag_accepted_session (session, reset_msg->handle,
610 VCL_ACCEPTED_F_RESET))
611 VDBG (0, "session was not accepted!");
612 return VCL_INVALID_SESSION_INDEX;
615 if (session->session_state != VCL_STATE_CLOSED)
616 session->session_state = VCL_STATE_DISCONNECT;
617 VDBG (0, "reset session %u [0x%llx]", sid, reset_msg->handle);
622 vcl_session_bound_handler (vcl_worker_t * wrk, session_bound_msg_t * mp)
624 vcl_session_t *session;
625 u32 sid = mp->context;
627 session = vcl_session_get (wrk, sid);
630 VERR ("session %u [0x%llx]: bind failed: %U", sid, mp->handle,
631 format_session_error, mp->retval);
634 session->session_state = VCL_STATE_DETACHED;
635 session->vpp_handle = mp->handle;
640 VDBG (0, "ERROR: session %u [0x%llx]: Invalid session index!",
642 return VCL_INVALID_SESSION_INDEX;
646 session->vpp_handle = mp->handle;
647 session->transport.is_ip4 = mp->lcl_is_ip4;
648 clib_memcpy_fast (&session->transport.lcl_ip, mp->lcl_ip,
649 sizeof (ip46_address_t));
650 session->transport.lcl_port = mp->lcl_port;
651 vcl_session_table_add_listener (wrk, mp->handle, sid);
652 session->session_state = VCL_STATE_LISTEN;
654 if (vcl_session_is_cl (session))
656 if (vcl_segment_attach_session (mp->segment_handle, mp->rx_fifo,
657 mp->tx_fifo, mp->vpp_evt_q, 0, session))
659 VDBG (0, "failed to attach fifos for %u", session->session_index);
660 session->session_state = VCL_STATE_DETACHED;
661 return VCL_INVALID_SESSION_INDEX;
665 VDBG (0, "session %u [0x%llx]: listen succeeded!", sid, mp->handle);
670 vcl_session_unlisten_reply_handler (vcl_worker_t * wrk, void *data)
672 session_unlisten_reply_msg_t *mp = (session_unlisten_reply_msg_t *) data;
675 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
678 VDBG (0, "Unlisten reply with wrong handle %llx", mp->handle);
681 if (s->session_state != VCL_STATE_DISCONNECT)
683 /* Connected udp listener */
684 if (s->session_type == VPPCOM_PROTO_UDP
685 && s->session_state == VCL_STATE_CLOSED)
688 VDBG (0, "Unlisten session in wrong state %llx", mp->handle);
693 VDBG (0, "ERROR: session %u [0xllx]: unlisten failed: %U",
694 s->session_index, mp->handle, format_session_error, mp->retval);
696 if (mp->context != wrk->wrk_index)
697 VDBG (0, "wrong context");
699 vcl_session_table_del_vpp_handle (wrk, mp->handle);
700 vcl_session_free (wrk, s);
704 vcl_session_migrated_handler (vcl_worker_t * wrk, void *data)
706 session_migrated_msg_t *mp = (session_migrated_msg_t *) data;
710 s = vcl_session_get_w_vpp_handle (wrk, mp->handle);
713 VDBG (0, "Migrated notification with wrong handle %llx", mp->handle);
717 /* Only validate if a value is provided */
718 if (mp->segment_handle != SESSION_INVALID_HANDLE)
720 fs_index = vcl_segment_table_lookup (mp->segment_handle);
721 if (fs_index == VCL_INVALID_SEGMENT_INDEX)
723 VDBG (0, "segment %lx for session %u is not mounted!",
724 mp->segment_handle, s->session_index);
725 s->session_state = VCL_STATE_DETACHED;
730 s->vpp_handle = mp->new_handle;
732 vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0), mp->vpp_evt_q,
733 mp->vpp_thread_index, &s->vpp_evt_q);
735 vcl_session_table_del_vpp_handle (wrk, mp->handle);
736 vcl_session_table_add_vpp_handle (wrk, mp->new_handle, s->session_index);
738 /* Generate new tx event if we have outstanding data */
739 if (svm_fifo_has_event (s->tx_fifo))
740 app_send_io_evt_to_vpp (s->vpp_evt_q,
741 s->tx_fifo->shr->master_session_index,
742 SESSION_IO_EVT_TX, SVM_Q_WAIT);
744 VDBG (0, "Migrated 0x%lx to thread %u 0x%lx", mp->handle,
745 mp->vpp_thread_index, mp->new_handle);
748 static vcl_session_t *
749 vcl_session_accepted (vcl_worker_t * wrk, session_accepted_msg_t * msg)
751 vcl_session_msg_t *vcl_msg;
752 vcl_session_t *session;
754 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
755 if (PREDICT_FALSE (session != 0))
756 VWRN ("session overlap handle %lu state %u!", msg->handle,
757 session->session_state);
759 session = vcl_session_table_lookup_listener (wrk, msg->listener_handle);
762 VERR ("couldn't find listen session: listener handle %llx",
763 msg->listener_handle);
767 clib_fifo_add2 (session->accept_evts_fifo, vcl_msg);
769 vcl_msg->accepted_msg = *msg;
770 /* Session handle points to listener until fully accepted by app */
771 vcl_session_table_add_vpp_handle (wrk, msg->handle, session->session_index);
776 static vcl_session_t *
777 vcl_session_disconnected_handler (vcl_worker_t * wrk,
778 session_disconnected_msg_t * msg)
780 vcl_session_t *session;
782 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
785 VDBG (0, "request to disconnect unknown handle 0x%llx", msg->handle);
789 /* Late disconnect notification on a session that has been closed */
790 if (session->session_state == VCL_STATE_CLOSED)
793 /* Caught a disconnect before actually accepting the session */
794 if (session->session_state == VCL_STATE_LISTEN)
796 if (!vcl_flag_accepted_session (session, msg->handle,
797 VCL_ACCEPTED_F_CLOSED))
798 VDBG (0, "session was not accepted!");
802 /* If not already reset change state */
803 if (session->session_state != VCL_STATE_DISCONNECT)
804 session->session_state = VCL_STATE_VPP_CLOSING;
810 vppcom_session_shutdown (uint32_t session_handle)
812 vcl_worker_t *wrk = vcl_worker_get_current ();
813 vcl_session_t *session;
814 vcl_session_state_t state;
817 session = vcl_session_get_w_handle (wrk, session_handle);
818 if (PREDICT_FALSE (!session))
819 return VPPCOM_EBADFD;
821 vpp_handle = session->vpp_handle;
822 state = session->session_state;
824 VDBG (1, "session %u [0x%llx] state 0x%x (%s)", session->session_index,
825 vpp_handle, state, vppcom_session_state_str (state));
827 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
829 VDBG (0, "ERROR: Cannot shutdown a listen socket!");
830 return VPPCOM_EBADFD;
833 if (PREDICT_TRUE (state == VCL_STATE_READY))
835 VDBG (1, "session %u [0x%llx]: sending shutdown...",
836 session->session_index, vpp_handle);
838 vcl_send_session_shutdown (wrk, session);
839 session->flags |= VCL_SESSION_F_SHUTDOWN;
846 vppcom_session_disconnect (u32 session_handle)
848 vcl_worker_t *wrk = vcl_worker_get_current ();
849 vcl_session_t *session, *listen_session;
850 vcl_session_state_t state;
853 session = vcl_session_get_w_handle (wrk, session_handle);
855 return VPPCOM_EBADFD;
857 vpp_handle = session->vpp_handle;
858 state = session->session_state;
860 VDBG (1, "session %u [0x%llx] state 0x%x (%s)", session->session_index,
861 vpp_handle, state, vppcom_session_state_str (state));
863 if (PREDICT_FALSE (state == VCL_STATE_LISTEN))
865 VDBG (0, "ERROR: Cannot disconnect a listen socket!");
866 return VPPCOM_EBADFD;
869 if (state == VCL_STATE_VPP_CLOSING)
871 vcl_send_session_disconnected_reply (wrk, session, 0);
872 VDBG (1, "session %u [0x%llx]: sending disconnect REPLY...",
873 session->session_index, vpp_handle);
877 /* Session doesn't have an event queue yet. Probably a non-blocking
878 * connect. Wait for the reply */
879 if (PREDICT_FALSE (!session->vpp_evt_q))
882 VDBG (1, "session %u [0x%llx]: sending disconnect...",
883 session->session_index, vpp_handle);
884 vcl_send_session_disconnect (wrk, session);
887 if (session->listener_index != VCL_INVALID_SESSION_INDEX)
889 listen_session = vcl_session_get (wrk, session->listener_index);
890 listen_session->n_accepted_sessions--;
897 vcl_session_cleanup_handler (vcl_worker_t * wrk, void *data)
899 session_cleanup_msg_t *msg;
900 vcl_session_t *session;
902 msg = (session_cleanup_msg_t *) data;
903 session = vcl_session_get_w_vpp_handle (wrk, msg->handle);
906 VDBG (0, "disconnect confirmed for unknown handle 0x%llx", msg->handle);
910 if (msg->type == SESSION_CLEANUP_TRANSPORT)
912 /* Transport was cleaned up before we confirmed close. Probably the
913 * app is still waiting for some data that cannot be delivered.
914 * Confirm close to make sure everything is cleaned up.
915 * Move to undetermined state to ensure that the session is not
916 * removed before both vpp and the app cleanup.
917 * - If the app closes first, the session is moved to CLOSED state
918 * and the session cleanup notification from vpp removes the
920 * - If vpp cleans up the session first, the session is moved to
921 * DETACHED state lower and subsequently the close from the app
924 if (session->session_state == VCL_STATE_VPP_CLOSING)
926 vppcom_session_disconnect (vcl_session_handle (session));
927 session->session_state = VCL_STATE_UPDATED;
929 else if (session->session_state == VCL_STATE_DISCONNECT)
931 vcl_send_session_reset_reply (wrk, session, 0);
932 session->session_state = VCL_STATE_UPDATED;
937 vcl_session_table_del_vpp_handle (wrk, msg->handle);
938 /* Should not happen. App did not close the connection so don't free it. */
939 if (session->session_state != VCL_STATE_CLOSED)
941 VDBG (0, "app did not close session %d", session->session_index);
942 session->session_state = VCL_STATE_DETACHED;
943 session->vpp_handle = VCL_INVALID_SESSION_HANDLE;
946 vcl_session_free (wrk, session);
950 vcl_session_req_worker_update_handler (vcl_worker_t * wrk, void *data)
952 session_req_worker_update_msg_t *msg;
955 msg = (session_req_worker_update_msg_t *) data;
956 s = vcl_session_get_w_vpp_handle (wrk, msg->session_handle);
960 vec_add1 (wrk->pending_session_wrk_updates, s->session_index);
964 vcl_session_worker_update_reply_handler (vcl_worker_t * wrk, void *data)
966 session_worker_update_reply_msg_t *msg;
969 msg = (session_worker_update_reply_msg_t *) data;
970 s = vcl_session_get_w_vpp_handle (wrk, msg->handle);
973 VDBG (0, "unknown handle 0x%llx", msg->handle);
979 if (vcl_segment_attach_session (msg->segment_handle, msg->rx_fifo,
980 msg->tx_fifo, (uword) ~0, 0, s))
982 VDBG (0, "failed to attach fifos for %u", s->session_index);
986 s->session_state = VCL_STATE_UPDATED;
988 VDBG (0, "session %u[0x%llx] moved to worker %u", s->session_index,
989 s->vpp_handle, wrk->wrk_index);
993 vcl_api_recv_fd (vcl_worker_t * wrk, int *fds, int n_fds)
996 if (vcm->cfg.vpp_app_socket_api)
997 return vcl_sapi_recv_fds (wrk, fds, n_fds);
999 return vcl_bapi_recv_fds (wrk, fds, n_fds);
1003 vcl_session_app_add_segment_handler (vcl_worker_t * wrk, void *data)
1005 ssvm_segment_type_t seg_type = SSVM_SEGMENT_SHM;
1006 session_app_add_segment_msg_t *msg;
1010 msg = (session_app_add_segment_msg_t *) data;
1014 vcl_api_recv_fd (wrk, &fd, 1);
1015 seg_type = SSVM_SEGMENT_MEMFD;
1018 segment_handle = msg->segment_handle;
1019 if (segment_handle == VCL_INVALID_SEGMENT_HANDLE)
1021 clib_warning ("invalid segment handle");
1025 if (vcl_segment_attach (segment_handle, (char *) msg->segment_name,
1028 VDBG (0, "vcl_segment_attach ('%s') failed", msg->segment_name);
1032 VDBG (1, "mapped new segment '%s' size %d", msg->segment_name,
1037 vcl_session_app_del_segment_handler (vcl_worker_t * wrk, void *data)
1039 session_app_del_segment_msg_t *msg = (session_app_del_segment_msg_t *) data;
1040 vcl_segment_detach (msg->segment_handle);
1041 VDBG (1, "Unmapped segment: %d", msg->segment_handle);
1045 vcl_worker_rpc_handler (vcl_worker_t * wrk, void *data)
1047 if (!vcm->wrk_rpc_fn)
1050 (vcm->wrk_rpc_fn) (((session_app_wrk_rpc_msg_t *) data)->data);
1054 vcl_session_transport_attr_reply_handler (vcl_worker_t *wrk, void *data)
1056 session_transport_attr_reply_msg_t *mp;
1058 if (!wrk->session_attr_op)
1061 mp = (session_transport_attr_reply_msg_t *) data;
1063 wrk->session_attr_op_rv = mp->retval;
1064 wrk->session_attr_op = 0;
1065 wrk->session_attr_rv = mp->attr;
1069 vcl_handle_mq_event (vcl_worker_t * wrk, session_event_t * e)
1071 session_disconnected_msg_t *disconnected_msg;
1072 session_connected_msg_t *connected_msg;
1073 session_reset_msg_t *reset_msg;
1074 session_event_t *ecpy;
1078 switch (e->event_type)
1080 case SESSION_IO_EVT_RX:
1081 case SESSION_IO_EVT_TX:
1082 s = vcl_session_get (wrk, e->session_index);
1083 if (!s || !vcl_session_is_open (s))
1085 vec_add1 (wrk->unhandled_evts_vector, *e);
1087 case SESSION_CTRL_EVT_BOUND:
1088 /* We can only wait for only one listen so not postponed */
1089 vcl_session_bound_handler (wrk, (session_bound_msg_t *) e->data);
1091 case SESSION_CTRL_EVT_ACCEPTED:
1092 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
1093 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1095 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1097 ecpy->postponed = 1;
1098 ecpy->session_index = s->session_index;
1101 case SESSION_CTRL_EVT_CONNECTED:
1102 connected_msg = (session_connected_msg_t *) e->data;
1103 sid = vcl_session_connected_handler (wrk, connected_msg);
1104 if (!(s = vcl_session_get (wrk, sid)))
1106 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1108 vec_add2 (wrk->unhandled_evts_vector, ecpy, 1);
1110 ecpy->postponed = 1;
1111 ecpy->session_index = s->session_index;
1114 case SESSION_CTRL_EVT_DISCONNECTED:
1115 disconnected_msg = (session_disconnected_msg_t *) e->data;
1116 if (!(s = vcl_session_get_w_vpp_handle (wrk, disconnected_msg->handle)))
1118 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1120 vec_add1 (wrk->unhandled_evts_vector, *e);
1123 if (!(s = vcl_session_disconnected_handler (wrk, disconnected_msg)))
1125 VDBG (0, "disconnected session %u [0x%llx]", s->session_index,
1128 case SESSION_CTRL_EVT_RESET:
1129 reset_msg = (session_reset_msg_t *) e->data;
1130 if (!(s = vcl_session_get_w_vpp_handle (wrk, reset_msg->handle)))
1132 if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
1134 vec_add1 (wrk->unhandled_evts_vector, *e);
1137 vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
1139 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
1140 vcl_session_unlisten_reply_handler (wrk, e->data);
1142 case SESSION_CTRL_EVT_MIGRATED:
1143 vcl_session_migrated_handler (wrk, e->data);
1145 case SESSION_CTRL_EVT_CLEANUP:
1146 vcl_session_cleanup_handler (wrk, e->data);
1148 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
1149 vcl_session_req_worker_update_handler (wrk, e->data);
1151 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
1152 vcl_session_worker_update_reply_handler (wrk, e->data);
1154 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
1155 vcl_session_app_add_segment_handler (wrk, e->data);
1157 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
1158 vcl_session_app_del_segment_handler (wrk, e->data);
1160 case SESSION_CTRL_EVT_APP_WRK_RPC:
1161 vcl_worker_rpc_handler (wrk, e->data);
1163 case SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY:
1164 vcl_session_transport_attr_reply_handler (wrk, e->data);
1167 clib_warning ("unhandled %u", e->event_type);
1173 vppcom_wait_for_session_state_change (u32 session_index,
1174 vcl_session_state_t state,
1177 vcl_worker_t *wrk = vcl_worker_get_current ();
1178 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
1179 vcl_session_t *volatile session;
1180 svm_msg_q_msg_t msg;
1185 session = vcl_session_get (wrk, session_index);
1186 if (PREDICT_FALSE (!session))
1188 return VPPCOM_EBADFD;
1190 if (session->session_state == state)
1194 if (session->session_state == VCL_STATE_DETACHED)
1196 return VPPCOM_ECONNREFUSED;
1199 if (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0))
1204 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
1205 vcl_handle_mq_event (wrk, e);
1206 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
1208 while (clib_time_now (&wrk->clib_time) < timeout);
1210 VDBG (0, "timeout waiting for state 0x%x (%s)", state,
1211 vppcom_session_state_str (state));
1212 vcl_evt (VCL_EVT_SESSION_TIMEOUT, session, session_state);
1214 return VPPCOM_ETIMEDOUT;
1218 vcl_handle_pending_wrk_updates (vcl_worker_t * wrk)
1220 vcl_session_state_t state;
1224 if (PREDICT_TRUE (vec_len (wrk->pending_session_wrk_updates) == 0))
1227 vec_foreach (sip, wrk->pending_session_wrk_updates)
1229 s = vcl_session_get (wrk, *sip);
1230 vcl_send_session_worker_update (wrk, s, wrk->wrk_index);
1231 state = s->session_state;
1232 vppcom_wait_for_session_state_change (s->session_index, VCL_STATE_UPDATED,
1234 s->session_state = state;
1236 vec_reset_length (wrk->pending_session_wrk_updates);
1240 vcl_worker_flush_mq_events (vcl_worker_t *wrk)
1242 svm_msg_q_msg_t *msg;
1247 mq = wrk->app_event_queue;
1248 vcl_mq_dequeue_batch (wrk, mq, ~0);
1250 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
1252 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
1253 e = svm_msg_q_msg_data (mq, msg);
1254 vcl_handle_mq_event (wrk, e);
1255 svm_msg_q_free_msg (mq, msg);
1257 vec_reset_length (wrk->mq_msg_vector);
1258 vcl_handle_pending_wrk_updates (wrk);
1262 vcl_flush_mq_events (void)
1264 vcl_worker_flush_mq_events (vcl_worker_get_current ());
1268 vppcom_session_unbind (u32 session_handle)
1270 vcl_worker_t *wrk = vcl_worker_get_current ();
1271 session_accepted_msg_t *accepted_msg;
1272 vcl_session_t *session = 0;
1273 vcl_session_msg_t *evt;
1275 session = vcl_session_get_w_handle (wrk, session_handle);
1277 return VPPCOM_EBADFD;
1279 /* Flush pending accept events, if any */
1280 while (clib_fifo_elts (session->accept_evts_fifo))
1282 clib_fifo_sub2 (session->accept_evts_fifo, evt);
1283 accepted_msg = &evt->accepted_msg;
1284 vcl_session_table_del_vpp_handle (wrk, accepted_msg->handle);
1285 vcl_send_session_accepted_reply (session->vpp_evt_q,
1286 accepted_msg->context,
1287 accepted_msg->handle, -1);
1289 clib_fifo_free (session->accept_evts_fifo);
1291 vcl_send_session_unlisten (wrk, session);
1293 VDBG (1, "session %u [0x%llx]: sending unbind!", session->session_index,
1294 session->vpp_handle);
1295 vcl_evt (VCL_EVT_UNBIND, session);
1297 session->vpp_handle = ~0;
1298 session->session_state = VCL_STATE_DISCONNECT;
1306 * Notify vpp of the disconnect and mark the worker as free. If we're the
1307 * last worker, do a full cleanup otherwise, since we're probably a forked
1308 * child, avoid syscalls as much as possible. We might've lost privileges.
1311 vppcom_app_exit (void)
1313 if (!pool_elts (vcm->workers))
1315 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
1316 vcl_set_worker_index (~0);
1317 vcl_elog_stop (vcm);
1321 vcl_api_attach (void)
1323 if (vcm->cfg.vpp_app_socket_api)
1324 return vcl_sapi_attach ();
1326 return vcl_bapi_attach ();
1330 vcl_api_detach (vcl_worker_t * wrk)
1332 vcl_send_app_detach (wrk);
1334 if (vcm->cfg.vpp_app_socket_api)
1335 return vcl_sapi_detach (wrk);
1337 return vcl_bapi_disconnect_from_vpp ();
1341 * VPPCOM Public API functions
1344 vppcom_app_create (const char *app_name)
1346 vppcom_cfg_t *vcl_cfg = &vcm->cfg;
1351 VDBG (1, "already initialized");
1352 return VPPCOM_EEXIST;
1356 vppcom_cfg (&vcm->cfg);
1357 vcl_cfg = &vcm->cfg;
1359 vcm->main_cpu = pthread_self ();
1360 vcm->main_pid = getpid ();
1361 vcm->app_name = format (0, "%s", app_name);
1362 fifo_segment_main_init (&vcm->segment_main, vcl_cfg->segment_baseva,
1363 20 /* timeout in secs */ );
1364 pool_alloc (vcm->workers, vcl_cfg->max_workers);
1365 clib_spinlock_init (&vcm->workers_lock);
1366 clib_rwlock_init (&vcm->segment_table_lock);
1367 atexit (vppcom_app_exit);
1368 vcl_elog_init (vcm);
1370 /* Allocate default worker */
1371 vcl_worker_alloc_and_init ();
1373 if ((rv = vcl_api_attach ()))
1376 VDBG (0, "app_name '%s', my_client_index %d (0x%x)", app_name,
1377 vcm->workers[0].api_client_handle, vcm->workers[0].api_client_handle);
1383 vppcom_app_destroy (void)
1385 vcl_worker_t *wrk, *current_wrk;
1388 if (!pool_elts (vcm->workers))
1391 vcl_evt (VCL_EVT_DETACH, vcm);
1393 current_wrk = vcl_worker_get_current ();
1396 pool_foreach (wrk, vcm->workers) {
1397 if (current_wrk != wrk)
1398 vcl_worker_cleanup (wrk, 0 /* notify vpp */ );
1402 vcl_api_detach (current_wrk);
1403 vcl_worker_cleanup (current_wrk, 0 /* notify vpp */ );
1405 vcl_elog_stop (vcm);
1408 * Free the heap and fix vcm
1410 heap = clib_mem_get_heap ();
1411 munmap (clib_mem_get_heap_base (heap), clib_mem_get_heap_size (heap));
1413 vcm = &_vppcom_main;
1418 vppcom_session_create (u8 proto, u8 is_nonblocking)
1420 vcl_worker_t *wrk = vcl_worker_get_current ();
1421 vcl_session_t *session;
1423 session = vcl_session_alloc (wrk);
1425 session->session_type = proto;
1426 session->session_state = VCL_STATE_CLOSED;
1427 session->vpp_handle = ~0;
1428 session->is_dgram = vcl_proto_is_dgram (proto);
1431 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
1433 vcl_evt (VCL_EVT_CREATE, session, session_type, session->session_state,
1434 is_nonblocking, session_index);
1436 VDBG (0, "created session %u", session->session_index);
1438 return vcl_session_handle (session);
1442 vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * s,
1443 vcl_session_handle_t sh, u8 do_disconnect)
1447 VDBG (1, "session %u [0x%llx] closing", s->session_index, s->vpp_handle);
1449 if (s->flags & VCL_SESSION_F_IS_VEP)
1451 u32 next_sh = s->vep.next_sh;
1452 while (next_sh != ~0)
1454 rv = vppcom_epoll_ctl (sh, EPOLL_CTL_DEL, next_sh, 0);
1455 if (PREDICT_FALSE (rv < 0))
1456 VDBG (0, "vpp handle 0x%llx, sh %u: EPOLL_CTL_DEL vep_idx %u"
1457 " failed! rv %d (%s)", s->vpp_handle, next_sh,
1458 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1459 next_sh = s->vep.next_sh;
1464 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
1466 rv = vppcom_epoll_ctl (s->vep.vep_sh, EPOLL_CTL_DEL, sh, 0);
1468 VDBG (0, "session %u [0x%llx]: EPOLL_CTL_DEL vep_idx %u "
1469 "failed! rv %d (%s)", s->session_index, s->vpp_handle,
1470 s->vep.vep_sh, rv, vppcom_retval_str (rv));
1475 VDBG (1, "session %u [0x%llx] disconnect skipped",
1476 s->session_index, s->vpp_handle);
1480 if (s->session_state == VCL_STATE_LISTEN)
1482 rv = vppcom_session_unbind (sh);
1483 if (PREDICT_FALSE (rv < 0))
1484 VDBG (0, "session %u [0x%llx]: listener unbind failed! "
1485 "rv %d (%s)", s->session_index, s->vpp_handle, rv,
1486 vppcom_retval_str (rv));
1489 else if (vcl_session_is_ready (s)
1490 || (vcl_session_is_connectable_listener (wrk, s)))
1492 rv = vppcom_session_disconnect (sh);
1493 if (PREDICT_FALSE (rv < 0))
1494 VDBG (0, "ERROR: session %u [0x%llx]: disconnect failed!"
1495 " rv %d (%s)", s->session_index, s->vpp_handle,
1496 rv, vppcom_retval_str (rv));
1498 else if (s->session_state == VCL_STATE_DISCONNECT)
1500 vcl_send_session_reset_reply (wrk, s, 0);
1502 else if (s->session_state == VCL_STATE_DETACHED)
1504 /* Should not happen. VPP cleaned up before app confirmed close */
1505 VDBG (0, "vpp freed session %d before close", s->session_index);
1509 s->session_state = VCL_STATE_CLOSED;
1511 /* Session is removed only after vpp confirms the disconnect */
1515 vcl_session_table_del_vpp_handle (wrk, s->vpp_handle);
1517 vcl_session_free (wrk, s);
1518 vcl_evt (VCL_EVT_CLOSE, s, rv);
1524 vppcom_session_close (uint32_t session_handle)
1526 vcl_worker_t *wrk = vcl_worker_get_current ();
1527 vcl_session_t *session;
1529 session = vcl_session_get_w_handle (wrk, session_handle);
1531 return VPPCOM_EBADFD;
1532 return vcl_session_cleanup (wrk, session, session_handle,
1533 1 /* do_disconnect */ );
1537 vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep)
1539 vcl_worker_t *wrk = vcl_worker_get_current ();
1540 vcl_session_t *session = 0;
1543 return VPPCOM_EINVAL;
1545 session = vcl_session_get_w_handle (wrk, session_handle);
1547 return VPPCOM_EBADFD;
1549 if (session->flags & VCL_SESSION_F_IS_VEP)
1551 VDBG (0, "ERROR: cannot bind to epoll session %u!",
1552 session->session_index);
1553 return VPPCOM_EBADFD;
1556 session->transport.is_ip4 = ep->is_ip4;
1558 clib_memcpy_fast (&session->transport.lcl_ip.ip4, ep->ip,
1559 sizeof (ip4_address_t));
1561 clib_memcpy_fast (&session->transport.lcl_ip.ip6, ep->ip,
1562 sizeof (ip6_address_t));
1563 session->transport.lcl_port = ep->port;
1565 VDBG (0, "session %u handle %u: binding to local %s address %U port %u, "
1566 "proto %s", session->session_index, session_handle,
1567 session->transport.is_ip4 ? "IPv4" : "IPv6",
1568 format_ip46_address, &session->transport.lcl_ip,
1569 session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1570 clib_net_to_host_u16 (session->transport.lcl_port),
1571 vppcom_proto_str (session->session_type));
1572 vcl_evt (VCL_EVT_BIND, session);
1574 if (session->session_type == VPPCOM_PROTO_UDP)
1575 vppcom_session_listen (session_handle, 10);
1581 vppcom_session_listen (uint32_t listen_sh, uint32_t q_len)
1583 vcl_worker_t *wrk = vcl_worker_get_current ();
1584 vcl_session_t *listen_session = 0;
1585 u64 listen_vpp_handle;
1588 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1589 if (!listen_session || (listen_session->flags & VCL_SESSION_F_IS_VEP))
1590 return VPPCOM_EBADFD;
1592 if (q_len == 0 || q_len == ~0)
1593 q_len = vcm->cfg.listen_queue_size;
1595 listen_vpp_handle = listen_session->vpp_handle;
1596 if (listen_session->session_state == VCL_STATE_LISTEN)
1598 VDBG (0, "session %u [0x%llx]: already in listen state!",
1599 listen_sh, listen_vpp_handle);
1603 VDBG (0, "session %u: sending vpp listen request...", listen_sh);
1606 * Send listen request to vpp and wait for reply
1608 vcl_send_session_listen (wrk, listen_session);
1609 rv = vppcom_wait_for_session_state_change (listen_session->session_index,
1611 vcm->cfg.session_timeout);
1613 if (PREDICT_FALSE (rv))
1615 listen_session = vcl_session_get_w_handle (wrk, listen_sh);
1616 VDBG (0, "session %u [0x%llx]: listen failed! returning %d (%s)",
1617 listen_sh, listen_session->vpp_handle, rv,
1618 vppcom_retval_str (rv));
1626 validate_args_session_accept_ (vcl_worker_t * wrk, vcl_session_t * ls)
1628 if (ls->flags & VCL_SESSION_F_IS_VEP)
1630 VDBG (0, "ERROR: cannot accept on epoll session %u!",
1632 return VPPCOM_EBADFD;
1635 if ((ls->session_state != VCL_STATE_LISTEN)
1636 && (!vcl_session_is_connectable_listener (wrk, ls)))
1638 VDBG (0, "ERROR: session [0x%llx]: not in listen state! state 0x%x"
1639 " (%s)", ls->vpp_handle, ls->session_state,
1640 vppcom_session_state_str (ls->session_state));
1641 return VPPCOM_EBADFD;
1647 vppcom_unformat_proto (uint8_t * proto, char *proto_str)
1649 if (!strcmp (proto_str, "TCP"))
1650 *proto = VPPCOM_PROTO_TCP;
1651 else if (!strcmp (proto_str, "tcp"))
1652 *proto = VPPCOM_PROTO_TCP;
1653 else if (!strcmp (proto_str, "UDP"))
1654 *proto = VPPCOM_PROTO_UDP;
1655 else if (!strcmp (proto_str, "udp"))
1656 *proto = VPPCOM_PROTO_UDP;
1657 else if (!strcmp (proto_str, "TLS"))
1658 *proto = VPPCOM_PROTO_TLS;
1659 else if (!strcmp (proto_str, "tls"))
1660 *proto = VPPCOM_PROTO_TLS;
1661 else if (!strcmp (proto_str, "QUIC"))
1662 *proto = VPPCOM_PROTO_QUIC;
1663 else if (!strcmp (proto_str, "quic"))
1664 *proto = VPPCOM_PROTO_QUIC;
1665 else if (!strcmp (proto_str, "DTLS"))
1666 *proto = VPPCOM_PROTO_DTLS;
1667 else if (!strcmp (proto_str, "dtls"))
1668 *proto = VPPCOM_PROTO_DTLS;
1669 else if (!strcmp (proto_str, "SRTP"))
1670 *proto = VPPCOM_PROTO_SRTP;
1671 else if (!strcmp (proto_str, "srtp"))
1672 *proto = VPPCOM_PROTO_SRTP;
1679 vppcom_session_accept (uint32_t listen_session_handle, vppcom_endpt_t * ep,
1682 u32 client_session_index = ~0, listen_session_index, accept_flags = 0;
1683 vcl_worker_t *wrk = vcl_worker_get_current ();
1684 session_accepted_msg_t accepted_msg;
1685 vcl_session_t *listen_session = 0;
1686 vcl_session_t *client_session = 0;
1687 vcl_session_msg_t *evt;
1693 listen_session = vcl_session_get_w_handle (wrk, listen_session_handle);
1694 if (!listen_session)
1695 return VPPCOM_EBADFD;
1697 listen_session_index = listen_session->session_index;
1698 if ((rv = validate_args_session_accept_ (wrk, listen_session)))
1701 if (clib_fifo_elts (listen_session->accept_evts_fifo))
1703 clib_fifo_sub2 (listen_session->accept_evts_fifo, evt);
1704 accept_flags = evt->flags;
1705 accepted_msg = evt->accepted_msg;
1709 is_nonblocking = vcl_session_has_attr (listen_session,
1710 VCL_SESS_ATTR_NONBLOCK);
1713 if (svm_msg_q_is_empty (wrk->app_event_queue) && is_nonblocking)
1714 return VPPCOM_EAGAIN;
1716 svm_msg_q_wait (wrk->app_event_queue, SVM_MQ_WAIT_EMPTY);
1717 vcl_worker_flush_mq_events (wrk);
1723 client_session_index = vcl_session_accepted_handler (wrk, &accepted_msg,
1724 listen_session_index);
1725 if (client_session_index == VCL_INVALID_SESSION_INDEX)
1726 return VPPCOM_ECONNABORTED;
1728 listen_session = vcl_session_get (wrk, listen_session_index);
1729 client_session = vcl_session_get (wrk, client_session_index);
1731 if (flags & O_NONBLOCK)
1732 vcl_session_set_attr (client_session, VCL_SESS_ATTR_NONBLOCK);
1734 VDBG (1, "listener %u [0x%llx]: Got a connect request! session %u [0x%llx],"
1735 " flags %d, is_nonblocking %u", listen_session->session_index,
1736 listen_session->vpp_handle, client_session_index,
1737 client_session->vpp_handle, flags,
1738 vcl_session_has_attr (client_session, VCL_SESS_ATTR_NONBLOCK));
1742 ep->is_ip4 = client_session->transport.is_ip4;
1743 ep->port = client_session->transport.rmt_port;
1744 if (client_session->transport.is_ip4)
1745 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip4,
1746 sizeof (ip4_address_t));
1748 clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip6,
1749 sizeof (ip6_address_t));
1752 VDBG (0, "listener %u [0x%llx] accepted %u [0x%llx] peer: %U:%u "
1753 "local: %U:%u", listen_session_handle, listen_session->vpp_handle,
1754 client_session_index, client_session->vpp_handle,
1755 format_ip46_address, &client_session->transport.rmt_ip,
1756 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1757 clib_net_to_host_u16 (client_session->transport.rmt_port),
1758 format_ip46_address, &client_session->transport.lcl_ip,
1759 client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
1760 clib_net_to_host_u16 (client_session->transport.lcl_port));
1761 vcl_evt (VCL_EVT_ACCEPT, client_session, listen_session,
1762 client_session_index);
1765 * Session might have been closed already
1769 if (accept_flags & VCL_ACCEPTED_F_CLOSED)
1770 client_session->session_state = VCL_STATE_VPP_CLOSING;
1771 else if (accept_flags & VCL_ACCEPTED_F_RESET)
1772 client_session->session_state = VCL_STATE_DISCONNECT;
1774 return vcl_session_handle (client_session);
1778 vppcom_session_connect (uint32_t session_handle, vppcom_endpt_t * server_ep)
1780 vcl_worker_t *wrk = vcl_worker_get_current ();
1781 vcl_session_t *session = 0;
1785 session = vcl_session_get_w_handle (wrk, session_handle);
1787 return VPPCOM_EBADFD;
1788 session_index = session->session_index;
1790 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1792 VDBG (0, "ERROR: cannot connect epoll session %u!",
1793 session->session_index);
1794 return VPPCOM_EBADFD;
1797 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1799 VDBG (0, "session handle %u [0x%llx]: session already "
1800 "connected to %s %U port %d proto %s, state 0x%x (%s)",
1801 session_handle, session->vpp_handle,
1802 session->transport.is_ip4 ? "IPv4" : "IPv6", format_ip46_address,
1803 &session->transport.rmt_ip, session->transport.is_ip4 ?
1804 IP46_TYPE_IP4 : IP46_TYPE_IP6,
1805 clib_net_to_host_u16 (session->transport.rmt_port),
1806 vppcom_proto_str (session->session_type), session->session_state,
1807 vppcom_session_state_str (session->session_state));
1811 /* Attempt to connect a connectionless listener */
1812 if (PREDICT_FALSE (session->session_state == VCL_STATE_LISTEN))
1814 if (session->session_type != VPPCOM_PROTO_UDP)
1815 return VPPCOM_EINVAL;
1816 vcl_send_session_unlisten (wrk, session);
1817 session->session_state = VCL_STATE_CLOSED;
1820 session->transport.is_ip4 = server_ep->is_ip4;
1821 vcl_ip_copy_from_ep (&session->transport.rmt_ip, server_ep);
1822 session->transport.rmt_port = server_ep->port;
1823 session->parent_handle = VCL_INVALID_SESSION_HANDLE;
1824 session->flags |= VCL_SESSION_F_CONNECTED;
1826 VDBG (0, "session handle %u (%s): connecting to peer %s %U "
1827 "port %d proto %s", session_handle,
1828 vppcom_session_state_str (session->session_state),
1829 session->transport.is_ip4 ? "IPv4" : "IPv6",
1830 format_ip46_address,
1831 &session->transport.rmt_ip, session->transport.is_ip4 ?
1832 IP46_TYPE_IP4 : IP46_TYPE_IP6,
1833 clib_net_to_host_u16 (session->transport.rmt_port),
1834 vppcom_proto_str (session->session_type));
1836 vcl_send_session_connect (wrk, session);
1838 if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK))
1840 /* State set to STATE_UPDATED to ensure the session is not assumed
1841 * to be ready and to also allow the app to close it prior to vpp's
1842 * connected reply. */
1843 session->session_state = VCL_STATE_UPDATED;
1844 return VPPCOM_EINPROGRESS;
1848 * Wait for reply from vpp if blocking
1850 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1851 vcm->cfg.session_timeout);
1853 session = vcl_session_get (wrk, session_index);
1854 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1855 session->vpp_handle, rv ? "failed" : "succeeded");
1861 vppcom_session_stream_connect (uint32_t session_handle,
1862 uint32_t parent_session_handle)
1864 vcl_worker_t *wrk = vcl_worker_get_current ();
1865 vcl_session_t *session, *parent_session;
1866 u32 session_index, parent_session_index;
1869 session = vcl_session_get_w_handle (wrk, session_handle);
1871 return VPPCOM_EBADFD;
1872 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1873 if (!parent_session)
1874 return VPPCOM_EBADFD;
1876 session_index = session->session_index;
1877 parent_session_index = parent_session->session_index;
1878 if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP))
1880 VDBG (0, "ERROR: cannot connect epoll session %u!",
1881 session->session_index);
1882 return VPPCOM_EBADFD;
1885 if (PREDICT_FALSE (vcl_session_is_ready (session)))
1887 VDBG (0, "session handle %u [0x%llx]: session already "
1888 "connected to session %u [0x%llx] proto %s, state 0x%x (%s)",
1889 session_handle, session->vpp_handle,
1890 parent_session_handle, parent_session->vpp_handle,
1891 vppcom_proto_str (session->session_type), session->session_state,
1892 vppcom_session_state_str (session->session_state));
1896 /* Connect to quic session specifics */
1897 session->transport.is_ip4 = parent_session->transport.is_ip4;
1898 session->transport.rmt_ip.ip4.as_u32 = (uint32_t) 1;
1899 session->transport.rmt_port = 0;
1900 session->parent_handle = parent_session->vpp_handle;
1902 VDBG (0, "session handle %u: connecting to session %u [0x%llx]",
1903 session_handle, parent_session_handle, parent_session->vpp_handle);
1906 * Send connect request and wait for reply from vpp
1908 vcl_send_session_connect (wrk, session);
1909 rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY,
1910 vcm->cfg.session_timeout);
1912 session->listener_index = parent_session_index;
1913 parent_session = vcl_session_get_w_handle (wrk, parent_session_handle);
1915 parent_session->n_accepted_sessions++;
1917 session = vcl_session_get (wrk, session_index);
1918 VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index,
1919 session->vpp_handle, rv ? "failed" : "succeeded");
1925 vppcom_session_read_internal (uint32_t session_handle, void *buf, int n,
1928 vcl_worker_t *wrk = vcl_worker_get_current ();
1929 int rv, n_read = 0, is_nonblocking;
1930 vcl_session_t *s = 0;
1931 svm_fifo_t *rx_fifo;
1936 if (PREDICT_FALSE (!buf))
1937 return VPPCOM_EINVAL;
1939 s = vcl_session_get_w_handle (wrk, session_handle);
1940 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
1941 return VPPCOM_EBADFD;
1943 if (PREDICT_FALSE (!vcl_session_is_open (s)))
1945 VDBG (0, "session %u[0x%llx] is not open! state 0x%x (%s)",
1946 s->session_index, s->vpp_handle, s->session_state,
1947 vppcom_session_state_str (s->session_state));
1948 return vcl_session_closed_error (s);
1951 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
1952 is_ct = vcl_session_is_ct (s);
1953 mq = wrk->app_event_queue;
1954 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
1955 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
1957 if (svm_fifo_is_empty_cons (rx_fifo))
1961 if (vcl_session_is_closing (s))
1962 return vcl_session_closing_error (s);
1964 svm_fifo_unset_event (s->rx_fifo);
1965 svm_fifo_unset_event (rx_fifo);
1966 return VPPCOM_EWOULDBLOCK;
1968 while (svm_fifo_is_empty_cons (rx_fifo))
1970 if (vcl_session_is_closing (s))
1971 return vcl_session_closing_error (s);
1974 svm_fifo_unset_event (s->rx_fifo);
1975 svm_fifo_unset_event (rx_fifo);
1977 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
1978 vcl_worker_flush_mq_events (wrk);
1985 rv = app_recv_dgram_raw (rx_fifo, buf, n, &s->transport, 0, peek);
1987 rv = app_recv_stream_raw (rx_fifo, buf, n, 0, peek);
1996 if (svm_fifo_is_empty_cons (rx_fifo))
1999 svm_fifo_unset_event (s->rx_fifo);
2000 svm_fifo_unset_event (rx_fifo);
2001 if (!svm_fifo_is_empty_cons (rx_fifo)
2002 && svm_fifo_set_event (rx_fifo) && is_nonblocking)
2004 vec_add2 (wrk->unhandled_evts_vector, e, 1);
2005 e->event_type = SESSION_IO_EVT_RX;
2006 e->session_index = s->session_index;
2009 else if (PREDICT_FALSE (rv < n && !s->is_dgram))
2011 /* More data enqueued while reading. Try to drain it
2012 * or fill the buffer. Avoid doing that for dgrams */
2018 if (PREDICT_FALSE (svm_fifo_needs_deq_ntf (rx_fifo, n_read)))
2020 svm_fifo_clear_deq_ntf (rx_fifo);
2021 app_send_io_evt_to_vpp (s->vpp_evt_q,
2022 s->rx_fifo->shr->master_session_index,
2023 SESSION_IO_EVT_RX, SVM_Q_WAIT);
2026 VDBG (2, "session %u[0x%llx]: read %d bytes from (%p)", s->session_index,
2027 s->vpp_handle, n_read, rx_fifo);
2033 vppcom_session_read (uint32_t session_handle, void *buf, size_t n)
2035 return (vppcom_session_read_internal (session_handle, buf, n, 0));
2039 vppcom_session_peek (uint32_t session_handle, void *buf, int n)
2041 return (vppcom_session_read_internal (session_handle, buf, n, 1));
2045 vppcom_session_read_segments (uint32_t session_handle,
2046 vppcom_data_segment_t * ds, uint32_t n_segments,
2049 vcl_worker_t *wrk = vcl_worker_get_current ();
2050 int n_read = 0, is_nonblocking;
2051 vcl_session_t *s = 0;
2052 svm_fifo_t *rx_fifo;
2056 s = vcl_session_get_w_handle (wrk, session_handle);
2057 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2058 return VPPCOM_EBADFD;
2060 if (PREDICT_FALSE (!vcl_session_is_open (s)))
2061 return vcl_session_closed_error (s);
2063 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2064 is_ct = vcl_session_is_ct (s);
2065 mq = wrk->app_event_queue;
2066 rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo;
2067 s->flags &= ~VCL_SESSION_F_HAS_RX_EVT;
2069 if (svm_fifo_is_empty_cons (rx_fifo))
2074 svm_fifo_unset_event (s->rx_fifo);
2075 svm_fifo_unset_event (rx_fifo);
2076 return VPPCOM_EWOULDBLOCK;
2078 while (svm_fifo_is_empty_cons (rx_fifo))
2080 if (vcl_session_is_closing (s))
2081 return vcl_session_closing_error (s);
2084 svm_fifo_unset_event (s->rx_fifo);
2085 svm_fifo_unset_event (rx_fifo);
2087 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2088 vcl_worker_flush_mq_events (wrk);
2092 n_read = svm_fifo_segments (rx_fifo, s->rx_bytes_pending,
2093 (svm_fifo_seg_t *) ds, n_segments, max_bytes);
2095 return VPPCOM_EAGAIN;
2097 if (svm_fifo_max_dequeue_cons (rx_fifo) == n_read)
2100 svm_fifo_unset_event (s->rx_fifo);
2101 svm_fifo_unset_event (rx_fifo);
2102 if (svm_fifo_max_dequeue_cons (rx_fifo) != n_read
2103 && svm_fifo_set_event (rx_fifo)
2104 && vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK))
2107 vec_add2 (wrk->unhandled_evts_vector, e, 1);
2108 e->event_type = SESSION_IO_EVT_RX;
2109 e->session_index = s->session_index;
2113 s->rx_bytes_pending += n_read;
2118 vppcom_session_free_segments (uint32_t session_handle, uint32_t n_bytes)
2120 vcl_worker_t *wrk = vcl_worker_get_current ();
2124 s = vcl_session_get_w_handle (wrk, session_handle);
2125 if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP)))
2128 is_ct = vcl_session_is_ct (s);
2129 svm_fifo_dequeue_drop (is_ct ? s->ct_rx_fifo : s->rx_fifo, n_bytes);
2131 ASSERT (s->rx_bytes_pending < n_bytes);
2132 s->rx_bytes_pending -= n_bytes;
2136 vcl_fifo_is_writeable (svm_fifo_t * f, u32 len, u8 is_dgram)
2138 u32 max_enq = svm_fifo_max_enqueue_prod (f);
2140 return max_enq >= (sizeof (session_dgram_hdr_t) + len);
2146 vppcom_session_write_inline (vcl_worker_t * wrk, vcl_session_t * s, void *buf,
2147 size_t n, u8 is_flush, u8 is_dgram)
2149 int n_write, is_nonblocking;
2150 session_evt_type_t et;
2151 svm_fifo_t *tx_fifo;
2155 /* Accept zero length writes but just return */
2156 if (PREDICT_FALSE (!n))
2159 if (PREDICT_FALSE (!buf))
2160 return VPPCOM_EFAULT;
2162 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2164 VDBG (0, "ERROR: session %u [0x%llx]: cannot write to an epoll"
2165 " session!", s->session_index, s->vpp_handle);
2166 return VPPCOM_EBADFD;
2169 if (PREDICT_FALSE (!vcl_session_is_open (s) ||
2170 (s->flags & VCL_SESSION_F_SHUTDOWN)))
2172 VDBG (1, "session %u [0x%llx]: is not open! state 0x%x (%s)",
2173 s->session_index, s->vpp_handle, s->session_state,
2174 vppcom_session_state_str (s->session_state));
2175 return vcl_session_closed_error (s);;
2178 is_ct = vcl_session_is_ct (s);
2179 tx_fifo = is_ct ? s->ct_tx_fifo : s->tx_fifo;
2180 is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK);
2182 mq = wrk->app_event_queue;
2183 if (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2187 return VPPCOM_EWOULDBLOCK;
2189 while (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram))
2191 svm_fifo_add_want_deq_ntf (tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF);
2192 if (vcl_session_is_closing (s))
2193 return vcl_session_closing_error (s);
2195 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2196 vcl_worker_flush_mq_events (wrk);
2200 et = SESSION_IO_EVT_TX;
2201 if (is_flush && !is_ct)
2202 et = SESSION_IO_EVT_TX_FLUSH;
2205 n_write = app_send_dgram_raw (tx_fifo, &s->transport,
2206 s->vpp_evt_q, buf, n, et,
2207 0 /* do_evt */ , SVM_Q_WAIT);
2209 n_write = app_send_stream_raw (tx_fifo, s->vpp_evt_q, buf, n, et,
2210 0 /* do_evt */ , SVM_Q_WAIT);
2212 if (svm_fifo_set_event (s->tx_fifo))
2213 app_send_io_evt_to_vpp (
2214 s->vpp_evt_q, s->tx_fifo->shr->master_session_index, et, SVM_Q_WAIT);
2216 /* The underlying fifo segment can run out of memory */
2217 if (PREDICT_FALSE (n_write < 0))
2218 return VPPCOM_EAGAIN;
2220 VDBG (2, "session %u [0x%llx]: wrote %d bytes", s->session_index,
2221 s->vpp_handle, n_write);
2227 vppcom_session_write (uint32_t session_handle, void *buf, size_t n)
2229 vcl_worker_t *wrk = vcl_worker_get_current ();
2232 s = vcl_session_get_w_handle (wrk, session_handle);
2233 if (PREDICT_FALSE (!s))
2234 return VPPCOM_EBADFD;
2236 return vppcom_session_write_inline (wrk, s, buf, n,
2237 0 /* is_flush */ , s->is_dgram ? 1 : 0);
2241 vppcom_session_write_msg (uint32_t session_handle, void *buf, size_t n)
2243 vcl_worker_t *wrk = vcl_worker_get_current ();
2246 s = vcl_session_get_w_handle (wrk, session_handle);
2247 if (PREDICT_FALSE (!s))
2248 return VPPCOM_EBADFD;
2250 return vppcom_session_write_inline (wrk, s, buf, n,
2251 1 /* is_flush */ , s->is_dgram ? 1 : 0);
2254 #define vcl_fifo_rx_evt_valid_or_break(_s) \
2255 if (PREDICT_FALSE (!_s->rx_fifo)) \
2257 if (PREDICT_FALSE (svm_fifo_is_empty (_s->rx_fifo))) \
2259 if (!vcl_session_is_ct (_s)) \
2261 svm_fifo_unset_event (_s->rx_fifo); \
2262 if (svm_fifo_is_empty (_s->rx_fifo)) \
2265 else if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2267 svm_fifo_unset_event (_s->rx_fifo); /* rx evts on actual fifo*/ \
2268 if (svm_fifo_is_empty (_s->ct_rx_fifo)) \
2274 vcl_select_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2275 unsigned long n_bits, unsigned long *read_map,
2276 unsigned long *write_map,
2277 unsigned long *except_map, u32 * bits_set)
2279 session_disconnected_msg_t *disconnected_msg;
2280 session_connected_msg_t *connected_msg;
2284 switch (e->event_type)
2286 case SESSION_IO_EVT_RX:
2287 sid = e->session_index;
2288 s = vcl_session_get (wrk, sid);
2289 if (!s || !vcl_session_is_open (s))
2291 vcl_fifo_rx_evt_valid_or_break (s);
2292 if (sid < n_bits && read_map)
2294 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2298 case SESSION_IO_EVT_TX:
2299 sid = e->session_index;
2300 s = vcl_session_get (wrk, sid);
2301 if (!s || !vcl_session_is_open (s))
2303 if (sid < n_bits && write_map)
2305 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2309 case SESSION_CTRL_EVT_ACCEPTED:
2311 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
2313 s = vcl_session_get (wrk, e->session_index);
2316 sid = s->session_index;
2317 if (sid < n_bits && read_map)
2319 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2323 case SESSION_CTRL_EVT_CONNECTED:
2326 connected_msg = (session_connected_msg_t *) e->data;
2327 sid = vcl_session_connected_handler (wrk, connected_msg);
2330 sid = e->session_index;
2331 if (sid == VCL_INVALID_SESSION_INDEX)
2333 if (sid < n_bits && write_map)
2335 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2339 case SESSION_CTRL_EVT_DISCONNECTED:
2340 disconnected_msg = (session_disconnected_msg_t *) e->data;
2341 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
2344 sid = s->session_index;
2345 if (sid < n_bits && except_map)
2347 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2351 case SESSION_CTRL_EVT_RESET:
2352 sid = vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
2353 if (sid < n_bits && except_map)
2355 clib_bitmap_set_no_check ((uword *) except_map, sid, 1);
2359 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
2360 vcl_session_unlisten_reply_handler (wrk, e->data);
2362 case SESSION_CTRL_EVT_MIGRATED:
2363 vcl_session_migrated_handler (wrk, e->data);
2365 case SESSION_CTRL_EVT_CLEANUP:
2366 vcl_session_cleanup_handler (wrk, e->data);
2368 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
2369 vcl_session_worker_update_reply_handler (wrk, e->data);
2371 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
2372 vcl_session_req_worker_update_handler (wrk, e->data);
2374 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
2375 vcl_session_app_add_segment_handler (wrk, e->data);
2377 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
2378 vcl_session_app_del_segment_handler (wrk, e->data);
2380 case SESSION_CTRL_EVT_APP_WRK_RPC:
2381 vcl_worker_rpc_handler (wrk, e->data);
2384 clib_warning ("unhandled: %u", e->event_type);
2390 vcl_select_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
2391 unsigned long n_bits, unsigned long *read_map,
2392 unsigned long *write_map, unsigned long *except_map,
2393 double time_to_wait, u32 * bits_set)
2395 svm_msg_q_msg_t *msg;
2399 if (svm_msg_q_is_empty (mq))
2406 else if (time_to_wait < 0)
2407 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
2410 if (svm_msg_q_timedwait (mq, time_to_wait))
2414 vcl_mq_dequeue_batch (wrk, mq, ~0);
2416 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
2418 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
2419 e = svm_msg_q_msg_data (mq, msg);
2420 vcl_select_handle_mq_event (wrk, e, n_bits, read_map, write_map,
2421 except_map, bits_set);
2422 svm_msg_q_free_msg (mq, msg);
2424 vec_reset_length (wrk->mq_msg_vector);
2425 vcl_handle_pending_wrk_updates (wrk);
2430 vppcom_select_condvar (vcl_worker_t * wrk, int n_bits,
2431 vcl_si_set * read_map, vcl_si_set * write_map,
2432 vcl_si_set * except_map, double time_to_wait,
2435 double wait = 0, start = 0;
2439 wait = time_to_wait;
2440 start = clib_time_now (&wrk->clib_time);
2445 vcl_select_handle_mq (wrk, wrk->app_event_queue, n_bits, read_map,
2446 write_map, except_map, wait, bits_set);
2452 wait = wait - (clib_time_now (&wrk->clib_time) - start);
2460 vppcom_select_eventfd (vcl_worker_t * wrk, int n_bits,
2461 vcl_si_set * read_map, vcl_si_set * write_map,
2462 vcl_si_set * except_map, double time_to_wait,
2465 vcl_mq_evt_conn_t *mqc;
2466 int __clib_unused n_read;
2470 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
2471 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
2472 vec_len (wrk->mq_events), time_to_wait);
2473 for (i = 0; i < n_mq_evts; i++)
2475 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
2476 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
2477 vcl_select_handle_mq (wrk, mqc->mq, n_bits, read_map, write_map,
2478 except_map, 0, bits_set);
2481 return (n_mq_evts > 0 ? (int) *bits_set : 0);
2485 vppcom_select (int n_bits, vcl_si_set * read_map, vcl_si_set * write_map,
2486 vcl_si_set * except_map, double time_to_wait)
2488 u32 sid, minbits = clib_max (n_bits, BITS (uword)), bits_set = 0;
2489 vcl_worker_t *wrk = vcl_worker_get_current ();
2490 vcl_session_t *s = 0;
2493 if (n_bits && read_map)
2495 clib_bitmap_validate (wrk->rd_bitmap, minbits);
2496 clib_memcpy_fast (wrk->rd_bitmap, read_map,
2497 vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2498 memset (read_map, 0, vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set));
2500 if (n_bits && write_map)
2502 clib_bitmap_validate (wrk->wr_bitmap, minbits);
2503 clib_memcpy_fast (wrk->wr_bitmap, write_map,
2504 vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2505 memset (write_map, 0, vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set));
2507 if (n_bits && except_map)
2509 clib_bitmap_validate (wrk->ex_bitmap, minbits);
2510 clib_memcpy_fast (wrk->ex_bitmap, except_map,
2511 vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2512 memset (except_map, 0, vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set));
2521 clib_bitmap_foreach (sid, wrk->wr_bitmap)
2523 if (!(s = vcl_session_get (wrk, sid)))
2525 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2530 if (vcl_session_write_ready (s))
2532 clib_bitmap_set_no_check ((uword *) write_map, sid, 1);
2537 svm_fifo_t *txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2538 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF);
2546 clib_bitmap_foreach (sid, wrk->rd_bitmap)
2548 if (!(s = vcl_session_get (wrk, sid)))
2550 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2555 if (vcl_session_read_ready (s))
2557 clib_bitmap_set_no_check ((uword *) read_map, sid, 1);
2564 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
2566 vcl_select_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i], n_bits,
2567 read_map, write_map, except_map, &bits_set);
2569 vec_reset_length (wrk->unhandled_evts_vector);
2571 if (vcm->cfg.use_mq_eventfd)
2572 vppcom_select_eventfd (wrk, n_bits, read_map, write_map, except_map,
2573 time_to_wait, &bits_set);
2575 vppcom_select_condvar (wrk, n_bits, read_map, write_map, except_map,
2576 time_to_wait, &bits_set);
2582 vep_verify_epoll_chain (vcl_worker_t * wrk, u32 vep_handle)
2584 vppcom_epoll_t *vep;
2585 u32 sh = vep_handle;
2588 if (VPPCOM_DEBUG <= 2)
2591 s = vcl_session_get_w_handle (wrk, vep_handle);
2592 if (PREDICT_FALSE (!s))
2594 VDBG (0, "ERROR: Invalid vep_sh (%u)!", vep_handle);
2597 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP)))
2599 VDBG (0, "ERROR: vep_sh (%u) is not a vep!", vep_handle);
2603 VDBG (0, "vep_sh (%u): Dumping epoll chain\n"
2606 " is_vep_session = %u\n"
2607 " next_sh = 0x%x (%u)\n"
2608 "}\n", vep_handle, s->flags & VCL_SESSION_F_IS_VEP,
2609 s->flags & VCL_SESSION_F_IS_VEP_SESSION, vep->next_sh, vep->next_sh);
2611 for (sh = vep->next_sh; sh != ~0; sh = vep->next_sh)
2613 s = vcl_session_get_w_handle (wrk, sh);
2614 if (PREDICT_FALSE (!s))
2616 VDBG (0, "ERROR: Invalid sh (%u)!", sh);
2619 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2621 VDBG (0, "ERROR: sh (%u) is a vep!", vep_handle);
2623 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2625 VDBG (0, "ERROR: sh (%u) is not a vep session handle!", sh);
2629 if (PREDICT_FALSE (vep->vep_sh != vep_handle))
2630 VDBG (0, "ERROR: session (%u) vep_sh (%u) != vep_sh (%u)!",
2631 sh, s->vep.vep_sh, vep_handle);
2632 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2634 VDBG (0, "vep_sh[%u]: sh 0x%x (%u)\n"
2636 " next_sh = 0x%x (%u)\n"
2637 " prev_sh = 0x%x (%u)\n"
2638 " vep_sh = 0x%x (%u)\n"
2639 " ev.events = 0x%x\n"
2640 " ev.data.u64 = 0x%llx\n"
2643 vep_handle, sh, sh, vep->next_sh, vep->next_sh, vep->prev_sh,
2644 vep->prev_sh, vep->vep_sh, vep->vep_sh, vep->ev.events,
2645 vep->ev.data.u64, vep->et_mask);
2650 VDBG (0, "vep_sh (%u): Dump complete!\n", vep_handle);
2654 vppcom_epoll_create (void)
2656 vcl_worker_t *wrk = vcl_worker_get_current ();
2657 vcl_session_t *vep_session;
2659 vep_session = vcl_session_alloc (wrk);
2661 vep_session->flags |= VCL_SESSION_F_IS_VEP;
2662 vep_session->vep.vep_sh = ~0;
2663 vep_session->vep.next_sh = ~0;
2664 vep_session->vep.prev_sh = ~0;
2665 vep_session->vpp_handle = ~0;
2667 vcl_evt (VCL_EVT_EPOLL_CREATE, vep_session, vep_session->session_index);
2668 VDBG (0, "Created vep_idx %u", vep_session->session_index);
2670 return vcl_session_handle (vep_session);
2674 vppcom_epoll_ctl (uint32_t vep_handle, int op, uint32_t session_handle,
2675 struct epoll_event *event)
2677 vcl_worker_t *wrk = vcl_worker_get_current ();
2678 vcl_session_t *vep_session;
2683 if (vep_handle == session_handle)
2685 VDBG (0, "vep_sh == session handle (%u)!", vep_handle);
2686 return VPPCOM_EINVAL;
2689 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
2690 if (PREDICT_FALSE (!vep_session))
2692 VDBG (0, "Invalid vep_sh (%u)!", vep_handle);
2693 return VPPCOM_EBADFD;
2695 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
2697 VDBG (0, "vep_sh (%u) is not a vep!", vep_handle);
2698 return VPPCOM_EINVAL;
2701 ASSERT (vep_session->vep.vep_sh == ~0);
2702 ASSERT (vep_session->vep.prev_sh == ~0);
2704 s = vcl_session_get_w_handle (wrk, session_handle);
2705 if (PREDICT_FALSE (!s))
2707 VDBG (0, "Invalid session_handle (%u)!", session_handle);
2708 return VPPCOM_EBADFD;
2710 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
2712 VDBG (0, "session_handle (%u) is a vep!", vep_handle);
2713 return VPPCOM_EINVAL;
2719 if (PREDICT_FALSE (!event))
2721 VDBG (0, "EPOLL_CTL_ADD: NULL pointer to epoll_event structure!");
2722 return VPPCOM_EINVAL;
2724 if (s->flags & VCL_SESSION_F_IS_VEP_SESSION)
2726 VDBG (0, "EPOLL_CTL_ADD: %u already epolled!", s->session_index);
2730 if (vep_session->vep.next_sh != ~0)
2732 vcl_session_t *next_session;
2733 next_session = vcl_session_get_w_handle (wrk,
2734 vep_session->vep.next_sh);
2735 if (PREDICT_FALSE (!next_session))
2737 VDBG (0, "EPOLL_CTL_ADD: Invalid vep.next_sh (%u) on "
2738 "vep_idx (%u)!", vep_session->vep.next_sh, vep_handle);
2739 return VPPCOM_EBADFD;
2741 ASSERT (next_session->vep.prev_sh == vep_handle);
2742 next_session->vep.prev_sh = session_handle;
2744 s->vep.next_sh = vep_session->vep.next_sh;
2745 s->vep.prev_sh = vep_handle;
2746 s->vep.vep_sh = vep_handle;
2747 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2749 s->flags &= ~VCL_SESSION_F_IS_VEP;
2750 s->flags |= VCL_SESSION_F_IS_VEP_SESSION;
2751 vep_session->vep.next_sh = session_handle;
2753 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2754 if (txf && (event->events & EPOLLOUT))
2755 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2757 /* Generate EPOLLOUT if tx fifo not full */
2758 if ((event->events & EPOLLOUT) && (vcl_session_write_ready (s) > 0))
2760 session_event_t e = { 0 };
2761 e.event_type = SESSION_IO_EVT_TX;
2762 e.session_index = s->session_index;
2763 vec_add1 (wrk->unhandled_evts_vector, e);
2765 /* Generate EPOLLIN if rx fifo has data */
2766 if ((event->events & EPOLLIN) && (vcl_session_read_ready (s) > 0))
2768 session_event_t e = { 0 };
2769 e.event_type = SESSION_IO_EVT_RX;
2770 e.session_index = s->session_index;
2771 vec_add1 (wrk->unhandled_evts_vector, e);
2773 VDBG (1, "EPOLL_CTL_ADD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2774 vep_handle, session_handle, event->events, event->data.u64);
2775 vcl_evt (VCL_EVT_EPOLL_CTLADD, s, event->events, event->data.u64);
2779 if (PREDICT_FALSE (!event))
2781 VDBG (0, "EPOLL_CTL_MOD: NULL pointer to epoll_event structure!");
2785 else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2787 VDBG (0, "sh %u EPOLL_CTL_MOD: not a vep session!", session_handle);
2791 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2793 VDBG (0, "EPOLL_CTL_MOD: sh %u vep_sh (%u) != vep_sh (%u)!",
2794 session_handle, s->vep.vep_sh, vep_handle);
2799 /* Generate EPOLLOUT if session write ready nd event was not on */
2800 if ((event->events & EPOLLOUT) && !(s->vep.ev.events & EPOLLOUT) &&
2801 (vcl_session_write_ready (s) > 0))
2803 session_event_t e = { 0 };
2804 e.event_type = SESSION_IO_EVT_TX;
2805 e.session_index = s->session_index;
2806 vec_add1 (wrk->unhandled_evts_vector, e);
2808 /* Generate EPOLLIN if session read ready and event was not on */
2809 if ((event->events & EPOLLIN) && !(s->vep.ev.events & EPOLLIN) &&
2810 (vcl_session_read_ready (s) > 0))
2812 session_event_t e = { 0 };
2813 e.event_type = SESSION_IO_EVT_RX;
2814 e.session_index = s->session_index;
2815 vec_add1 (wrk->unhandled_evts_vector, e);
2817 s->vep.et_mask = VEP_DEFAULT_ET_MASK;
2819 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2822 if (event->events & EPOLLOUT)
2823 svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2825 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2827 VDBG (1, "EPOLL_CTL_MOD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!",
2828 vep_handle, session_handle, event->events, event->data.u64);
2832 if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION)))
2834 VDBG (0, "EPOLL_CTL_DEL: %u not a vep session!", session_handle);
2838 else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle))
2840 VDBG (0, "EPOLL_CTL_DEL: sh %u vep_sh (%u) != vep_sh (%u)!",
2841 session_handle, s->vep.vep_sh, vep_handle);
2846 if (s->vep.prev_sh == vep_handle)
2847 vep_session->vep.next_sh = s->vep.next_sh;
2850 vcl_session_t *prev_session;
2851 prev_session = vcl_session_get_w_handle (wrk, s->vep.prev_sh);
2852 if (PREDICT_FALSE (!prev_session))
2854 VDBG (0, "EPOLL_CTL_DEL: Invalid prev_sh (%u) on sh (%u)!",
2855 s->vep.prev_sh, session_handle);
2856 return VPPCOM_EBADFD;
2858 ASSERT (prev_session->vep.next_sh == session_handle);
2859 prev_session->vep.next_sh = s->vep.next_sh;
2861 if (s->vep.next_sh != ~0)
2863 vcl_session_t *next_session;
2864 next_session = vcl_session_get_w_handle (wrk, s->vep.next_sh);
2865 if (PREDICT_FALSE (!next_session))
2867 VDBG (0, "EPOLL_CTL_DEL: Invalid next_sh (%u) on sh (%u)!",
2868 s->vep.next_sh, session_handle);
2869 return VPPCOM_EBADFD;
2871 ASSERT (next_session->vep.prev_sh == session_handle);
2872 next_session->vep.prev_sh = s->vep.prev_sh;
2875 memset (&s->vep, 0, sizeof (s->vep));
2876 s->vep.next_sh = ~0;
2877 s->vep.prev_sh = ~0;
2879 s->flags &= ~VCL_SESSION_F_IS_VEP_SESSION;
2881 if (vcl_session_is_open (s))
2883 txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo;
2885 svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL);
2888 VDBG (1, "EPOLL_CTL_DEL: vep_idx %u, sh %u!", vep_handle,
2890 vcl_evt (VCL_EVT_EPOLL_CTLDEL, s, vep_sh);
2894 VDBG (0, "Invalid operation (%d)!", op);
2898 vep_verify_epoll_chain (wrk, vep_handle);
2905 vcl_epoll_wait_handle_mq_event (vcl_worker_t * wrk, session_event_t * e,
2906 struct epoll_event *events, u32 * num_ev)
2908 session_disconnected_msg_t *disconnected_msg;
2909 session_connected_msg_t *connected_msg;
2910 u32 sid = ~0, session_events;
2911 u64 session_evt_data = ~0;
2915 switch (e->event_type)
2917 case SESSION_IO_EVT_RX:
2918 sid = e->session_index;
2919 s = vcl_session_get (wrk, sid);
2920 if (vcl_session_is_closed (s))
2922 vcl_fifo_rx_evt_valid_or_break (s);
2923 session_events = s->vep.ev.events;
2924 if (!(EPOLLIN & s->vep.ev.events)
2925 || (s->flags & VCL_SESSION_F_HAS_RX_EVT))
2928 events[*num_ev].events |= EPOLLIN;
2929 session_evt_data = s->vep.ev.data.u64;
2930 s->flags |= VCL_SESSION_F_HAS_RX_EVT;
2932 case SESSION_IO_EVT_TX:
2933 sid = e->session_index;
2934 s = vcl_session_get (wrk, sid);
2935 if (vcl_session_is_closed (s))
2937 session_events = s->vep.ev.events;
2938 if (!(EPOLLOUT & session_events))
2941 events[*num_ev].events |= EPOLLOUT;
2942 session_evt_data = s->vep.ev.data.u64;
2943 svm_fifo_reset_has_deq_ntf (vcl_session_is_ct (s) ?
2944 s->ct_tx_fifo : s->tx_fifo);
2946 case SESSION_CTRL_EVT_ACCEPTED:
2948 s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data);
2950 s = vcl_session_get (wrk, e->session_index);
2953 session_events = s->vep.ev.events;
2954 sid = s->session_index;
2955 if (!(EPOLLIN & session_events))
2958 events[*num_ev].events |= EPOLLIN;
2959 session_evt_data = s->vep.ev.data.u64;
2961 case SESSION_CTRL_EVT_CONNECTED:
2964 connected_msg = (session_connected_msg_t *) e->data;
2965 sid = vcl_session_connected_handler (wrk, connected_msg);
2968 sid = e->session_index;
2969 s = vcl_session_get (wrk, sid);
2970 if (vcl_session_is_closed (s))
2972 session_events = s->vep.ev.events;
2973 /* Generate EPOLLOUT because there's no connected event */
2974 if (!(EPOLLOUT & session_events))
2977 events[*num_ev].events |= EPOLLOUT;
2978 session_evt_data = s->vep.ev.data.u64;
2979 if (s->session_state == VCL_STATE_DETACHED)
2980 events[*num_ev].events |= EPOLLHUP;
2982 case SESSION_CTRL_EVT_DISCONNECTED:
2983 disconnected_msg = (session_disconnected_msg_t *) e->data;
2984 s = vcl_session_disconnected_handler (wrk, disconnected_msg);
2985 if (vcl_session_is_closed (s))
2987 sid = s->session_index;
2988 session_events = s->vep.ev.events;
2990 events[*num_ev].events |= EPOLLHUP | EPOLLRDHUP;
2991 session_evt_data = s->vep.ev.data.u64;
2993 case SESSION_CTRL_EVT_RESET:
2994 sid = vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data);
2995 s = vcl_session_get (wrk, sid);
2996 if (vcl_session_is_closed (s))
2998 session_events = s->vep.ev.events;
3000 events[*num_ev].events |= EPOLLHUP | EPOLLRDHUP;
3001 session_evt_data = s->vep.ev.data.u64;
3003 case SESSION_CTRL_EVT_UNLISTEN_REPLY:
3004 vcl_session_unlisten_reply_handler (wrk, e->data);
3006 case SESSION_CTRL_EVT_MIGRATED:
3007 vcl_session_migrated_handler (wrk, e->data);
3009 case SESSION_CTRL_EVT_CLEANUP:
3010 vcl_session_cleanup_handler (wrk, e->data);
3012 case SESSION_CTRL_EVT_REQ_WORKER_UPDATE:
3013 vcl_session_req_worker_update_handler (wrk, e->data);
3015 case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY:
3016 vcl_session_worker_update_reply_handler (wrk, e->data);
3018 case SESSION_CTRL_EVT_APP_ADD_SEGMENT:
3019 vcl_session_app_add_segment_handler (wrk, e->data);
3021 case SESSION_CTRL_EVT_APP_DEL_SEGMENT:
3022 vcl_session_app_del_segment_handler (wrk, e->data);
3024 case SESSION_CTRL_EVT_APP_WRK_RPC:
3025 vcl_worker_rpc_handler (wrk, e->data);
3028 VDBG (0, "unhandled: %u", e->event_type);
3034 events[*num_ev].data.u64 = session_evt_data;
3035 if (EPOLLONESHOT & session_events)
3037 s = vcl_session_get (wrk, sid);
3038 s->vep.ev.events = 0;
3045 vcl_epoll_wait_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq,
3046 struct epoll_event *events, u32 maxevents,
3047 double wait_for_time, u32 * num_ev)
3049 svm_msg_q_msg_t *msg;
3053 if (vec_len (wrk->mq_msg_vector) && svm_msg_q_is_empty (mq))
3054 goto handle_dequeued;
3056 if (svm_msg_q_is_empty (mq))
3060 else if (wait_for_time < 0)
3061 svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY);
3064 if (svm_msg_q_timedwait (mq, wait_for_time / 1e3))
3068 ASSERT (maxevents > *num_ev);
3069 vcl_mq_dequeue_batch (wrk, mq, ~0);
3072 for (i = 0; i < vec_len (wrk->mq_msg_vector); i++)
3074 msg = vec_elt_at_index (wrk->mq_msg_vector, i);
3075 e = svm_msg_q_msg_data (mq, msg);
3076 if (*num_ev < maxevents)
3077 vcl_epoll_wait_handle_mq_event (wrk, e, events, num_ev);
3079 vcl_handle_mq_event (wrk, e);
3080 svm_msg_q_free_msg (mq, msg);
3082 vec_reset_length (wrk->mq_msg_vector);
3083 vcl_handle_pending_wrk_updates (wrk);
3088 vppcom_epoll_wait_condvar (vcl_worker_t *wrk, struct epoll_event *events,
3089 int maxevents, u32 n_evts, double timeout_ms)
3096 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3101 vcl_epoll_wait_handle_mq (wrk, wrk->app_event_queue, events, maxevents,
3102 timeout_ms, &n_evts);
3103 if (n_evts || !timeout_ms)
3106 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3112 vppcom_epoll_wait_eventfd (vcl_worker_t *wrk, struct epoll_event *events,
3113 int maxevents, u32 n_evts, double timeout_ms)
3115 int __clib_unused n_read;
3116 vcl_mq_evt_conn_t *mqc;
3121 vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns));
3125 end = clib_time_now (&wrk->clib_time) + (timeout_ms / 1e3);
3130 n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events,
3131 vec_len (wrk->mq_events), timeout_ms);
3134 VDBG (0, "epoll_wait error %u", errno);
3138 for (i = 0; i < n_mq_evts; i++)
3140 mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32);
3141 n_read = read (mqc->mq_fd, &buf, sizeof (buf));
3142 vcl_epoll_wait_handle_mq (wrk, mqc->mq, events, maxevents, 0,
3146 if (n_evts || !timeout_ms)
3149 while (end == -1 || clib_time_now (&wrk->clib_time) < end);
3155 vppcom_epoll_wait (uint32_t vep_handle, struct epoll_event *events,
3156 int maxevents, double wait_for_time)
3158 vcl_worker_t *wrk = vcl_worker_get_current ();
3159 vcl_session_t *vep_session;
3163 if (PREDICT_FALSE (maxevents <= 0))
3165 VDBG (0, "ERROR: Invalid maxevents (%d)!", maxevents);
3166 return VPPCOM_EINVAL;
3169 vep_session = vcl_session_get_w_handle (wrk, vep_handle);
3171 return VPPCOM_EBADFD;
3173 if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP)))
3175 VDBG (0, "ERROR: vep_idx (%u) is not a vep!", vep_handle);
3176 return VPPCOM_EINVAL;
3179 memset (events, 0, sizeof (*events) * maxevents);
3181 if (vec_len (wrk->unhandled_evts_vector))
3183 for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++)
3185 vcl_epoll_wait_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i],
3187 if (n_evts == maxevents)
3189 vec_delete (wrk->unhandled_evts_vector, i + 1, 0);
3193 vec_reset_length (wrk->unhandled_evts_vector);
3195 /* Request to only drain unhandled */
3196 if ((int) wait_for_time == -2)
3199 if (vcm->cfg.use_mq_eventfd)
3200 return vppcom_epoll_wait_eventfd (wrk, events, maxevents, n_evts,
3203 return vppcom_epoll_wait_condvar (wrk, events, maxevents, n_evts,
3208 vppcom_session_attr (uint32_t session_handle, uint32_t op,
3209 void *buffer, uint32_t * buflen)
3211 vcl_worker_t *wrk = vcl_worker_get_current ();
3212 u32 *flags = buffer, tmp_flags = 0;
3213 vppcom_endpt_t *ep = buffer;
3214 transport_endpt_attr_t tea;
3215 vcl_session_t *session;
3218 session = vcl_session_get_w_handle (wrk, session_handle);
3220 return VPPCOM_EBADFD;
3224 case VPPCOM_ATTR_GET_NREAD:
3225 rv = vcl_session_read_ready (session);
3226 VDBG (2, "VPPCOM_ATTR_GET_NREAD: sh %u, nread = %d", session_handle,
3230 case VPPCOM_ATTR_GET_NWRITE:
3231 rv = vcl_session_write_ready (session);
3232 VDBG (2, "VPPCOM_ATTR_GET_NWRITE: sh %u, nwrite = %d", session_handle,
3236 case VPPCOM_ATTR_GET_FLAGS:
3237 if (PREDICT_TRUE (buffer && buflen && (*buflen >= sizeof (*flags))))
3241 (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK) ?
3243 *buflen = sizeof (*flags);
3244 VDBG (2, "VPPCOM_ATTR_GET_FLAGS: sh %u, flags = 0x%08x, "
3245 "is_nonblocking = %u", session_handle, *flags,
3246 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3252 case VPPCOM_ATTR_SET_FLAGS:
3253 if (PREDICT_TRUE (buffer && buflen && (*buflen == sizeof (*flags))))
3255 if (*flags & O_NONBLOCK)
3256 vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK);
3258 vcl_session_clear_attr (session, VCL_SESS_ATTR_NONBLOCK);
3260 VDBG (2, "VPPCOM_ATTR_SET_FLAGS: sh %u, flags = 0x%08x,"
3261 " is_nonblocking = %u", session_handle, *flags,
3262 vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK));
3268 case VPPCOM_ATTR_GET_PEER_ADDR:
3269 if (PREDICT_TRUE (buffer && buflen &&
3270 (*buflen >= sizeof (*ep)) && ep->ip))
3272 ep->is_ip4 = session->transport.is_ip4;
3273 ep->port = session->transport.rmt_port;
3274 if (session->transport.is_ip4)
3275 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
3276 sizeof (ip4_address_t));
3278 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
3279 sizeof (ip6_address_t));
3280 *buflen = sizeof (*ep);
3281 VDBG (1, "VPPCOM_ATTR_GET_PEER_ADDR: sh %u, is_ip4 = %u, "
3282 "addr = %U, port %u", session_handle, ep->is_ip4,
3283 format_ip46_address, &session->transport.rmt_ip,
3284 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3285 clib_net_to_host_u16 (ep->port));
3291 case VPPCOM_ATTR_GET_LCL_ADDR:
3292 if (PREDICT_TRUE (buffer && buflen &&
3293 (*buflen >= sizeof (*ep)) && ep->ip))
3295 ep->is_ip4 = session->transport.is_ip4;
3296 ep->port = session->transport.lcl_port;
3297 if (session->transport.is_ip4)
3298 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip4,
3299 sizeof (ip4_address_t));
3301 clib_memcpy_fast (ep->ip, &session->transport.lcl_ip.ip6,
3302 sizeof (ip6_address_t));
3303 *buflen = sizeof (*ep);
3304 VDBG (1, "VPPCOM_ATTR_GET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3305 " port %d", session_handle, ep->is_ip4, format_ip46_address,
3306 &session->transport.lcl_ip,
3307 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3308 clib_net_to_host_u16 (ep->port));
3314 case VPPCOM_ATTR_SET_LCL_ADDR:
3315 if (PREDICT_TRUE (buffer && buflen &&
3316 (*buflen >= sizeof (*ep)) && ep->ip))
3318 session->transport.is_ip4 = ep->is_ip4;
3319 session->transport.lcl_port = ep->port;
3320 vcl_ip_copy_from_ep (&session->transport.lcl_ip, ep);
3321 *buflen = sizeof (*ep);
3322 VDBG (1, "VPPCOM_ATTR_SET_LCL_ADDR: sh %u, is_ip4 = %u, addr = %U"
3323 " port %d", session_handle, ep->is_ip4, format_ip46_address,
3324 &session->transport.lcl_ip,
3325 ep->is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6,
3326 clib_net_to_host_u16 (ep->port));
3332 case VPPCOM_ATTR_GET_LIBC_EPFD:
3333 rv = session->libc_epfd;
3334 VDBG (2, "VPPCOM_ATTR_GET_LIBC_EPFD: libc_epfd %d", rv);
3337 case VPPCOM_ATTR_SET_LIBC_EPFD:
3338 if (PREDICT_TRUE (buffer && buflen &&
3339 (*buflen == sizeof (session->libc_epfd))))
3341 session->libc_epfd = *(int *) buffer;
3342 *buflen = sizeof (session->libc_epfd);
3344 VDBG (2, "VPPCOM_ATTR_SET_LIBC_EPFD: libc_epfd %d, buflen %d",
3345 session->libc_epfd, *buflen);
3351 case VPPCOM_ATTR_GET_PROTOCOL:
3352 if (buffer && buflen && (*buflen >= sizeof (int)))
3354 *(int *) buffer = session->session_type;
3355 *buflen = sizeof (int);
3357 VDBG (2, "VPPCOM_ATTR_GET_PROTOCOL: %d (%s), buflen %d",
3358 *(int *) buffer, *(int *) buffer ? "UDP" : "TCP", *buflen);
3364 case VPPCOM_ATTR_GET_LISTEN:
3365 if (buffer && buflen && (*buflen >= sizeof (int)))
3367 *(int *) buffer = vcl_session_has_attr (session,
3368 VCL_SESS_ATTR_LISTEN);
3369 *buflen = sizeof (int);
3371 VDBG (2, "VPPCOM_ATTR_GET_LISTEN: %d, buflen %d", *(int *) buffer,
3378 case VPPCOM_ATTR_GET_ERROR:
3379 if (buffer && buflen && (*buflen >= sizeof (int)))
3381 *(int *) buffer = 0;
3382 *buflen = sizeof (int);
3384 VDBG (2, "VPPCOM_ATTR_GET_ERROR: %d, buflen %d, #VPP-TBD#",
3385 *(int *) buffer, *buflen);
3391 case VPPCOM_ATTR_GET_TX_FIFO_LEN:
3392 if (buffer && buflen && (*buflen >= sizeof (u32)))
3396 *(size_t *) buffer = (session->sndbuf_size ? session->sndbuf_size :
3398 svm_fifo_size (session->tx_fifo) :
3399 vcm->cfg.tx_fifo_size);
3400 *buflen = sizeof (u32);
3402 VDBG (2, "VPPCOM_ATTR_GET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3403 " #VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer,
3410 case VPPCOM_ATTR_SET_TX_FIFO_LEN:
3411 if (buffer && buflen && (*buflen == sizeof (u32)))
3414 session->sndbuf_size = *(u32 *) buffer;
3415 VDBG (2, "VPPCOM_ATTR_SET_TX_FIFO_LEN: %u (0x%x), buflen %d,"
3416 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3423 case VPPCOM_ATTR_GET_RX_FIFO_LEN:
3424 if (buffer && buflen && (*buflen >= sizeof (u32)))
3428 *(size_t *) buffer = (session->rcvbuf_size ? session->rcvbuf_size :
3430 svm_fifo_size (session->rx_fifo) :
3431 vcm->cfg.rx_fifo_size);
3432 *buflen = sizeof (u32);
3434 VDBG (2, "VPPCOM_ATTR_GET_RX_FIFO_LEN: %u (0x%x), buflen %d, "
3435 "#VPP-TBD#", *(size_t *) buffer, *(size_t *) buffer, *buflen);
3441 case VPPCOM_ATTR_SET_RX_FIFO_LEN:
3442 if (buffer && buflen && (*buflen == sizeof (u32)))
3445 session->rcvbuf_size = *(u32 *) buffer;
3446 VDBG (2, "VPPCOM_ATTR_SET_RX_FIFO_LEN: %u (0x%x), buflen %d,"
3447 " #VPP-TBD#", session->sndbuf_size, session->sndbuf_size,
3454 case VPPCOM_ATTR_GET_REUSEADDR:
3455 if (buffer && buflen && (*buflen >= sizeof (int)))
3458 *(int *) buffer = vcl_session_has_attr (session,
3459 VCL_SESS_ATTR_REUSEADDR);
3460 *buflen = sizeof (int);
3462 VDBG (2, "VPPCOM_ATTR_GET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3463 *(int *) buffer, *buflen);
3469 case VPPCOM_ATTR_SET_REUSEADDR:
3470 if (buffer && buflen && (*buflen == sizeof (int)) &&
3471 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3474 if (*(int *) buffer)
3475 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEADDR);
3477 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEADDR);
3479 VDBG (2, "VPPCOM_ATTR_SET_REUSEADDR: %d, buflen %d, #VPP-TBD#",
3480 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEADDR),
3487 case VPPCOM_ATTR_GET_REUSEPORT:
3488 if (buffer && buflen && (*buflen >= sizeof (int)))
3491 *(int *) buffer = vcl_session_has_attr (session,
3492 VCL_SESS_ATTR_REUSEPORT);
3493 *buflen = sizeof (int);
3495 VDBG (2, "VPPCOM_ATTR_GET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3496 *(int *) buffer, *buflen);
3502 case VPPCOM_ATTR_SET_REUSEPORT:
3503 if (buffer && buflen && (*buflen == sizeof (int)) &&
3504 !vcl_session_has_attr (session, VCL_SESS_ATTR_LISTEN))
3507 if (*(int *) buffer)
3508 vcl_session_set_attr (session, VCL_SESS_ATTR_REUSEPORT);
3510 vcl_session_clear_attr (session, VCL_SESS_ATTR_REUSEPORT);
3512 VDBG (2, "VPPCOM_ATTR_SET_REUSEPORT: %d, buflen %d, #VPP-TBD#",
3513 vcl_session_has_attr (session, VCL_SESS_ATTR_REUSEPORT),
3520 case VPPCOM_ATTR_GET_BROADCAST:
3521 if (buffer && buflen && (*buflen >= sizeof (int)))
3524 *(int *) buffer = vcl_session_has_attr (session,
3525 VCL_SESS_ATTR_BROADCAST);
3526 *buflen = sizeof (int);
3528 VDBG (2, "VPPCOM_ATTR_GET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3529 *(int *) buffer, *buflen);
3535 case VPPCOM_ATTR_SET_BROADCAST:
3536 if (buffer && buflen && (*buflen == sizeof (int)))
3539 if (*(int *) buffer)
3540 vcl_session_set_attr (session, VCL_SESS_ATTR_BROADCAST);
3542 vcl_session_clear_attr (session, VCL_SESS_ATTR_BROADCAST);
3544 VDBG (2, "VPPCOM_ATTR_SET_BROADCAST: %d, buflen %d, #VPP-TBD#",
3545 vcl_session_has_attr (session, VCL_SESS_ATTR_BROADCAST),
3552 case VPPCOM_ATTR_GET_V6ONLY:
3553 if (buffer && buflen && (*buflen >= sizeof (int)))
3556 *(int *) buffer = vcl_session_has_attr (session,
3557 VCL_SESS_ATTR_V6ONLY);
3558 *buflen = sizeof (int);
3560 VDBG (2, "VPPCOM_ATTR_GET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3561 *(int *) buffer, *buflen);
3567 case VPPCOM_ATTR_SET_V6ONLY:
3568 if (buffer && buflen && (*buflen == sizeof (int)))
3571 if (*(int *) buffer)
3572 vcl_session_set_attr (session, VCL_SESS_ATTR_V6ONLY);
3574 vcl_session_clear_attr (session, VCL_SESS_ATTR_V6ONLY);
3576 VDBG (2, "VPPCOM_ATTR_SET_V6ONLY: %d, buflen %d, #VPP-TBD#",
3577 vcl_session_has_attr (session, VCL_SESS_ATTR_V6ONLY),
3584 case VPPCOM_ATTR_GET_KEEPALIVE:
3585 if (buffer && buflen && (*buflen >= sizeof (int)))
3588 *(int *) buffer = vcl_session_has_attr (session,
3589 VCL_SESS_ATTR_KEEPALIVE);
3590 *buflen = sizeof (int);
3592 VDBG (2, "VPPCOM_ATTR_GET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3593 *(int *) buffer, *buflen);
3599 case VPPCOM_ATTR_SET_KEEPALIVE:
3600 if (buffer && buflen && (*buflen == sizeof (int)))
3603 if (*(int *) buffer)
3604 vcl_session_set_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3606 vcl_session_clear_attr (session, VCL_SESS_ATTR_KEEPALIVE);
3608 VDBG (2, "VPPCOM_ATTR_SET_KEEPALIVE: %d, buflen %d, #VPP-TBD#",
3609 vcl_session_has_attr (session, VCL_SESS_ATTR_KEEPALIVE),
3616 case VPPCOM_ATTR_GET_TCP_NODELAY:
3617 if (buffer && buflen && (*buflen >= sizeof (int)))
3620 *(int *) buffer = vcl_session_has_attr (session,
3621 VCL_SESS_ATTR_TCP_NODELAY);
3622 *buflen = sizeof (int);
3624 VDBG (2, "VPPCOM_ATTR_GET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3625 *(int *) buffer, *buflen);
3631 case VPPCOM_ATTR_SET_TCP_NODELAY:
3632 if (buffer && buflen && (*buflen == sizeof (int)))
3635 if (*(int *) buffer)
3636 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3638 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_NODELAY);
3640 VDBG (2, "VPPCOM_ATTR_SET_TCP_NODELAY: %d, buflen %d, #VPP-TBD#",
3641 vcl_session_has_attr (session, VCL_SESS_ATTR_TCP_NODELAY),
3648 case VPPCOM_ATTR_GET_TCP_KEEPIDLE:
3649 if (buffer && buflen && (*buflen >= sizeof (int)))
3652 *(int *) buffer = vcl_session_has_attr (session,
3653 VCL_SESS_ATTR_TCP_KEEPIDLE);
3654 *buflen = sizeof (int);
3656 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3657 *(int *) buffer, *buflen);
3663 case VPPCOM_ATTR_SET_TCP_KEEPIDLE:
3664 if (buffer && buflen && (*buflen == sizeof (int)))
3667 if (*(int *) buffer)
3668 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3670 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPIDLE);
3672 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPIDLE: %d, buflen %d, #VPP-TBD#",
3673 vcl_session_has_attr (session,
3674 VCL_SESS_ATTR_TCP_KEEPIDLE), *buflen);
3680 case VPPCOM_ATTR_GET_TCP_KEEPINTVL:
3681 if (buffer && buflen && (*buflen >= sizeof (int)))
3684 *(int *) buffer = vcl_session_has_attr (session,
3685 VCL_SESS_ATTR_TCP_KEEPINTVL);
3686 *buflen = sizeof (int);
3688 VDBG (2, "VPPCOM_ATTR_GET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3689 *(int *) buffer, *buflen);
3695 case VPPCOM_ATTR_SET_TCP_KEEPINTVL:
3696 if (buffer && buflen && (*buflen == sizeof (int)))
3699 if (*(int *) buffer)
3700 vcl_session_set_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3702 vcl_session_clear_attr (session, VCL_SESS_ATTR_TCP_KEEPINTVL);
3704 VDBG (2, "VPPCOM_ATTR_SET_TCP_KEEPINTVL: %d, buflen %d, #VPP-TBD#",
3705 vcl_session_has_attr (session,
3706 VCL_SESS_ATTR_TCP_KEEPINTVL), *buflen);
3712 case VPPCOM_ATTR_GET_TCP_USER_MSS:
3713 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
3719 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3720 tea.mss = *(u32 *) buffer;
3721 if (vcl_session_transport_attr (wrk, session, 1 /* is_get */, &tea))
3722 rv = VPPCOM_ENOPROTOOPT;
3726 *(u32 *) buffer = tea.mss;
3727 *buflen = sizeof (int);
3730 VDBG (2, "VPPCOM_ATTR_GET_TCP_USER_MSS: %d, buflen %d", *(int *) buffer,
3734 case VPPCOM_ATTR_SET_TCP_USER_MSS:
3735 if (!(buffer && buflen && (*buflen == sizeof (u32))))
3741 tea.type = TRANSPORT_ENDPT_ATTR_MSS;
3742 tea.mss = *(u32 *) buffer;
3743 if (vcl_session_transport_attr (wrk, session, 0 /* is_get */, &tea))
3744 rv = VPPCOM_ENOPROTOOPT;
3746 VDBG (2, "VPPCOM_ATTR_SET_TCP_USER_MSS: %u, buflen %d", tea.mss,
3750 case VPPCOM_ATTR_SET_SHUT:
3751 if (*flags == SHUT_RD || *flags == SHUT_RDWR)
3752 vcl_session_set_attr (session, VCL_SESS_ATTR_SHUT_RD);
3753 if (*flags == SHUT_WR || *flags == SHUT_RDWR)
3754 vcl_session_set_attr (session, VCL_SESS_ATTR_SHUT_WR);
3757 case VPPCOM_ATTR_GET_SHUT:
3758 if (vcl_session_has_attr (session, VCL_SESS_ATTR_SHUT_RD))
3760 if (vcl_session_has_attr (session, VCL_SESS_ATTR_SHUT_WR))
3763 *(int *) buffer = SHUT_RD;
3764 else if (tmp_flags == 2)
3765 *(int *) buffer = SHUT_WR;
3766 else if (tmp_flags == 3)
3767 *(int *) buffer = SHUT_RDWR;
3768 *buflen = sizeof (int);
3771 case VPPCOM_ATTR_SET_CONNECTED:
3772 session->flags |= VCL_SESSION_F_CONNECTED;
3775 case VPPCOM_ATTR_SET_CKPAIR:
3776 if (!(buffer && buflen && (*buflen == sizeof (int))) ||
3777 !vcl_session_has_crypto (session))
3782 if (!session->ext_config)
3784 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_CRYPTO,
3785 sizeof (transport_endpt_ext_cfg_t));
3787 else if (session->ext_config->type != TRANSPORT_ENDPT_EXT_CFG_CRYPTO)
3793 session->ext_config->crypto.ckpair_index = *(uint32_t *) buffer;
3796 case VPPCOM_ATTR_SET_VRF:
3797 if (!(buffer && buflen && (*buflen == sizeof (u32))))
3802 session->vrf = *(u32 *) buffer;
3805 case VPPCOM_ATTR_GET_VRF:
3806 if (!(buffer && buflen && (*buflen >= sizeof (u32))))
3811 *(u32 *) buffer = session->vrf;
3812 *buflen = sizeof (u32);
3815 case VPPCOM_ATTR_GET_DOMAIN:
3816 if (!(buffer && buflen && (*buflen >= sizeof (int))))
3822 if (session->transport.is_ip4)
3823 *(int *) buffer = AF_INET;
3825 *(int *) buffer = AF_INET6;
3826 *buflen = sizeof (int);
3828 VDBG (2, "VPPCOM_ATTR_GET_DOMAIN: %d, buflen %u", *(int *) buffer,
3832 case VPPCOM_ATTR_SET_ENDPT_EXT_CFG:
3833 if (!(buffer && buflen && (*buflen > 0)))
3838 if (session->ext_config)
3843 vcl_session_alloc_ext_cfg (session, TRANSPORT_ENDPT_EXT_CFG_NONE,
3844 *buflen + sizeof (u32));
3845 clib_memcpy (session->ext_config->data, buffer, *buflen);
3846 session->ext_config->len = *buflen;
3858 vppcom_session_recvfrom (uint32_t session_handle, void *buffer,
3859 uint32_t buflen, int flags, vppcom_endpt_t * ep)
3861 vcl_worker_t *wrk = vcl_worker_get_current ();
3862 vcl_session_t *session;
3866 rv = vppcom_session_read (session_handle, buffer, buflen);
3867 else if (flags & MSG_PEEK)
3868 rv = vppcom_session_peek (session_handle, buffer, buflen);
3871 VDBG (0, "Unsupport flags for recvfrom %d", flags);
3872 return VPPCOM_EAFNOSUPPORT;
3877 session = vcl_session_get_w_handle (wrk, session_handle);
3878 if (session->transport.is_ip4)
3879 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip4,
3880 sizeof (ip4_address_t));
3882 clib_memcpy_fast (ep->ip, &session->transport.rmt_ip.ip6,
3883 sizeof (ip6_address_t));
3884 ep->is_ip4 = session->transport.is_ip4;
3885 ep->port = session->transport.rmt_port;
3892 vppcom_session_sendto (uint32_t session_handle, void *buffer,
3893 uint32_t buflen, int flags, vppcom_endpt_t * ep)
3895 vcl_worker_t *wrk = vcl_worker_get_current ();
3898 s = vcl_session_get_w_handle (wrk, session_handle);
3899 if (PREDICT_FALSE (!s))
3900 return VPPCOM_EBADFD;
3904 if (!vcl_session_is_cl (s))
3905 return VPPCOM_EINVAL;
3907 /* Session not connected/bound in vpp. Create it by 'connecting' it */
3908 if (PREDICT_FALSE (s->session_state == VCL_STATE_CLOSED))
3910 u32 session_index = s->session_index;
3911 f64 timeout = vcm->cfg.session_timeout;
3914 vcl_send_session_connect (wrk, s);
3915 rv = vppcom_wait_for_session_state_change (session_index,
3920 s = vcl_session_get (wrk, session_index);
3923 s->transport.is_ip4 = ep->is_ip4;
3924 s->transport.rmt_port = ep->port;
3925 vcl_ip_copy_from_ep (&s->transport.rmt_ip, ep);
3930 // TBD check the flags and do the right thing
3931 VDBG (2, "handling flags 0x%u (%d) not implemented yet.", flags, flags);
3934 return (vppcom_session_write_inline (wrk, s, buffer, buflen, 1,
3935 s->is_dgram ? 1 : 0));
3939 vppcom_poll (vcl_poll_t * vp, uint32_t n_sids, double wait_for_time)
3941 vcl_worker_t *wrk = vcl_worker_get_current ();
3942 f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time;
3943 u32 i, keep_trying = 1;
3944 svm_msg_q_msg_t msg;
3948 VDBG (3, "vp %p, nsids %u, wait_for_time %f", vp, n_sids, wait_for_time);
3951 return VPPCOM_EFAULT;
3955 vcl_session_t *session;
3957 /* Dequeue all events and drop all unhandled io events */
3958 while (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0) == 0)
3960 e = svm_msg_q_msg_data (wrk->app_event_queue, &msg);
3961 vcl_handle_mq_event (wrk, e);
3962 svm_msg_q_free_msg (wrk->app_event_queue, &msg);
3964 vec_reset_length (wrk->unhandled_evts_vector);
3966 for (i = 0; i < n_sids; i++)
3968 session = vcl_session_get (wrk, vp[i].sh);
3971 vp[i].revents = POLLHUP;
3978 if (POLLIN & vp[i].events)
3980 rv = vcl_session_read_ready (session);
3983 vp[i].revents |= POLLIN;
3990 case VPPCOM_ECONNRESET:
3991 vp[i].revents = POLLHUP;
3995 vp[i].revents = POLLERR;
4002 if (POLLOUT & vp[i].events)
4004 rv = vcl_session_write_ready (session);
4007 vp[i].revents |= POLLOUT;
4014 case VPPCOM_ECONNRESET:
4015 vp[i].revents = POLLHUP;
4019 vp[i].revents = POLLERR;
4026 if (0) // Note "done:" label used by VCL_SESSION_LOCK_AND_GET()
4028 vp[i].revents = POLLNVAL;
4032 if (wait_for_time != -1)
4033 keep_trying = (clib_time_now (&wrk->clib_time) <= timeout) ? 1 : 0;
4035 while ((num_ev == 0) && keep_trying);
4041 vppcom_mq_epoll_fd (void)
4043 vcl_worker_t *wrk = vcl_worker_get_current ();
4044 return wrk->mqs_epfd;
4048 vppcom_session_index (vcl_session_handle_t session_handle)
4050 return session_handle & 0xFFFFFF;
4054 vppcom_session_worker (vcl_session_handle_t session_handle)
4056 return session_handle >> 24;
4060 vppcom_worker_register (void)
4062 if (!vcl_worker_alloc_and_init ())
4063 return VPPCOM_EEXIST;
4065 if (vcl_worker_register_with_vpp ())
4066 return VPPCOM_EEXIST;
4072 vppcom_worker_unregister (void)
4074 vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ );
4075 vcl_set_worker_index (~0);
4079 vppcom_worker_index_set (int index)
4081 vcl_set_worker_index (index);
4085 vppcom_worker_index (void)
4087 return vcl_get_worker_index ();
4091 vppcom_worker_mqs_epfd (void)
4093 vcl_worker_t *wrk = vcl_worker_get_current ();
4094 if (!vcm->cfg.use_mq_eventfd)
4096 return wrk->mqs_epfd;
4100 vppcom_session_is_connectable_listener (uint32_t session_handle)
4102 vcl_session_t *session;
4103 vcl_worker_t *wrk = vcl_worker_get_current ();
4104 session = vcl_session_get_w_handle (wrk, session_handle);
4106 return VPPCOM_EBADFD;
4107 return vcl_session_is_connectable_listener (wrk, session);
4111 vppcom_session_listener (uint32_t session_handle)
4113 vcl_worker_t *wrk = vcl_worker_get_current ();
4114 vcl_session_t *listen_session, *session;
4115 session = vcl_session_get_w_handle (wrk, session_handle);
4117 return VPPCOM_EBADFD;
4118 if (session->listener_index == VCL_INVALID_SESSION_INDEX)
4119 return VPPCOM_EBADFD;
4120 listen_session = vcl_session_get_w_handle (wrk, session->listener_index);
4121 if (!listen_session)
4122 return VPPCOM_EBADFD;
4123 return vcl_session_handle (listen_session);
4127 vppcom_session_n_accepted (uint32_t session_handle)
4129 vcl_worker_t *wrk = vcl_worker_get_current ();
4130 vcl_session_t *session = vcl_session_get_w_handle (wrk, session_handle);
4132 return VPPCOM_EBADFD;
4133 return session->n_accepted_sessions;
4137 vppcom_proto_str (vppcom_proto_t proto)
4139 char const *proto_str;
4143 case VPPCOM_PROTO_TCP:
4146 case VPPCOM_PROTO_UDP:
4149 case VPPCOM_PROTO_TLS:
4152 case VPPCOM_PROTO_QUIC:
4155 case VPPCOM_PROTO_DTLS:
4158 case VPPCOM_PROTO_SRTP:
4162 proto_str = "UNKNOWN";
4169 vppcom_retval_str (int retval)
4180 st = "VPPCOM_EAGAIN";
4184 st = "VPPCOM_EFAULT";
4188 st = "VPPCOM_ENOMEM";
4192 st = "VPPCOM_EINVAL";
4196 st = "VPPCOM_EBADFD";
4199 case VPPCOM_EAFNOSUPPORT:
4200 st = "VPPCOM_EAFNOSUPPORT";
4203 case VPPCOM_ECONNABORTED:
4204 st = "VPPCOM_ECONNABORTED";
4207 case VPPCOM_ECONNRESET:
4208 st = "VPPCOM_ECONNRESET";
4211 case VPPCOM_ENOTCONN:
4212 st = "VPPCOM_ENOTCONN";
4215 case VPPCOM_ECONNREFUSED:
4216 st = "VPPCOM_ECONNREFUSED";
4219 case VPPCOM_ETIMEDOUT:
4220 st = "VPPCOM_ETIMEDOUT";
4224 st = "UNKNOWN_STATE";
4232 vppcom_add_cert_key_pair (vppcom_cert_key_pair_t *ckpair)
4234 if (vcm->cfg.vpp_app_socket_api)
4236 clib_warning ("not supported");
4237 return VPPCOM_EINVAL;
4239 return vcl_bapi_add_cert_key_pair (ckpair);
4243 vppcom_del_cert_key_pair (uint32_t ckpair_index)
4245 if (vcm->cfg.vpp_app_socket_api)
4247 clib_warning ("not supported");
4248 return VPPCOM_EINVAL;
4250 return vcl_bapi_del_cert_key_pair (ckpair_index);
4254 * fd.io coding-style-patch-verification: ON
4257 * eval: (c-set-style "gnu")