/* * Copyright (c) 2017-2019 Cisco and/or its affiliates. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this * You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #include #include #include #include #include #include __thread uword __vcl_worker_index = ~0; static inline int vcl_mq_dequeue_batch (vcl_worker_t * wrk, svm_msg_q_t * mq, u32 n_max_msg) { u32 n_msgs = 0, sz, len; while ((sz = svm_msg_q_size (mq))) { len = vec_len (wrk->mq_msg_vector); vec_validate (wrk->mq_msg_vector, len + sz - 1); svm_msg_q_sub_raw_batch (mq, wrk->mq_msg_vector + len, sz); n_msgs += sz; } return n_msgs; } static void vcl_msg_add_ext_config (vcl_session_t *s, uword *offset) { svm_fifo_chunk_t *c; c = vcl_segment_alloc_chunk (vcl_vpp_worker_segment_handle (0), 0 /* one slice only */, s->ext_config->len, offset); if (c) clib_memcpy_fast (c->data, s->ext_config, s->ext_config->len); } static void vcl_send_session_listen (vcl_worker_t * wrk, vcl_session_t * s) { app_session_evt_t _app_evt, *app_evt = &_app_evt; session_listen_msg_t *mp; svm_msg_q_t *mq; mq = vcl_worker_ctrl_mq (wrk); app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_LISTEN); mp = (session_listen_msg_t *) app_evt->evt->data; memset (mp, 0, sizeof (*mp)); mp->client_index = wrk->api_client_handle; mp->context = s->session_index; mp->wrk_index = wrk->vpp_wrk_index; mp->is_ip4 = s->transport.is_ip4; clib_memcpy_fast (&mp->ip, &s->transport.lcl_ip, sizeof (mp->ip)); mp->port = s->transport.lcl_port; mp->proto = s->session_type; mp->vrf = s->vrf; if (s->flags & VCL_SESSION_F_CONNECTED) mp->flags = TRANSPORT_CFG_F_CONNECTED; if (s->ext_config) vcl_msg_add_ext_config (s, &mp->ext_config); app_send_ctrl_evt_to_vpp (mq, app_evt); if (s->ext_config) { clib_mem_free (s->ext_config); s->ext_config = 0; } } static void vcl_send_session_connect (vcl_worker_t * wrk, vcl_session_t * s) { app_session_evt_t _app_evt, *app_evt = &_app_evt; session_connect_msg_t *mp; svm_msg_q_t *mq; mq = vcl_worker_ctrl_mq (wrk); app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_CONNECT); mp = (session_connect_msg_t *) app_evt->evt->data; memset (mp, 0, sizeof (*mp)); mp->client_index = wrk->api_client_handle; mp->context = s->session_index; mp->dscp = s->dscp; mp->wrk_index = wrk->vpp_wrk_index; mp->is_ip4 = s->transport.is_ip4; mp->parent_handle = s->parent_handle; clib_memcpy_fast (&mp->ip, &s->transport.rmt_ip, sizeof (mp->ip)); clib_memcpy_fast (&mp->lcl_ip, &s->transport.lcl_ip, sizeof (mp->lcl_ip)); mp->port = s->transport.rmt_port; mp->lcl_port = s->transport.lcl_port; mp->proto = s->session_type; mp->vrf = s->vrf; if (s->flags & VCL_SESSION_F_CONNECTED) mp->flags |= TRANSPORT_CFG_F_CONNECTED; if (s->ext_config) vcl_msg_add_ext_config (s, &mp->ext_config); app_send_ctrl_evt_to_vpp (mq, app_evt); if (s->ext_config) { clib_mem_free (s->ext_config); s->ext_config = 0; } } void vcl_send_session_unlisten (vcl_worker_t * wrk, vcl_session_t * s) { app_session_evt_t _app_evt, *app_evt = &_app_evt; session_unlisten_msg_t *mp; svm_msg_q_t *mq; mq = vcl_worker_ctrl_mq (wrk); app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_UNLISTEN); mp = (session_unlisten_msg_t *) app_evt->evt->data; memset (mp, 0, sizeof (*mp)); mp->client_index = wrk->api_client_handle; mp->wrk_index = wrk->vpp_wrk_index; mp->handle = s->vpp_handle; mp->context = wrk->wrk_index; app_send_ctrl_evt_to_vpp (mq, app_evt); } static void vcl_send_session_shutdown (vcl_worker_t *wrk, vcl_session_t *s) { app_session_evt_t _app_evt, *app_evt = &_app_evt; session_shutdown_msg_t *mp; svm_msg_q_t *mq; /* Send to thread that owns the session */ mq = s->vpp_evt_q; app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_SHUTDOWN); mp = (session_shutdown_msg_t *) app_evt->evt->data; memset (mp, 0, sizeof (*mp)); mp->client_index = wrk->api_client_handle; mp->handle = s->vpp_handle; app_send_ctrl_evt_to_vpp (mq, app_evt); } static void vcl_send_session_disconnect (vcl_worker_t * wrk, vcl_session_t * s) { app_session_evt_t _app_evt, *app_evt = &_app_evt; session_disconnect_msg_t *mp; svm_msg_q_t *mq; /* Send to thread that owns the session */ mq = s->vpp_evt_q; app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_DISCONNECT); mp = (session_disconnect_msg_t *) app_evt->evt->data; memset (mp, 0, sizeof (*mp)); mp->client_index = wrk->api_client_handle; mp->handle = s->vpp_handle; app_send_ctrl_evt_to_vpp (mq, app_evt); } static void vcl_send_app_detach (vcl_worker_t * wrk) { app_session_evt_t _app_evt, *app_evt = &_app_evt; session_app_detach_msg_t *mp; svm_msg_q_t *mq; mq = vcl_worker_ctrl_mq (wrk); app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_DETACH); mp = (session_app_detach_msg_t *) app_evt->evt->data; memset (mp, 0, sizeof (*mp)); mp->client_index = wrk->api_client_handle; app_send_ctrl_evt_to_vpp (mq, app_evt); } static void vcl_send_session_accepted_reply (svm_msg_q_t * mq, u32 context, session_handle_t handle, int retval) { app_session_evt_t _app_evt, *app_evt = &_app_evt; session_accepted_reply_msg_t *rmp; app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_ACCEPTED_REPLY); rmp = (session_accepted_reply_msg_t *) app_evt->evt->data; rmp->handle = handle; rmp->context = context; rmp->retval = retval; app_send_ctrl_evt_to_vpp (mq, app_evt); } static void vcl_send_session_disconnected_reply (vcl_worker_t * wrk, vcl_session_t * s, int retval) { app_session_evt_t _app_evt, *app_evt = &_app_evt; session_disconnected_reply_msg_t *rmp; app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt, SESSION_CTRL_EVT_DISCONNECTED_REPLY); rmp = (session_disconnected_reply_msg_t *) app_evt->evt->data; rmp->handle = s->vpp_handle; rmp->context = wrk->api_client_handle; rmp->retval = retval; app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt); } static void vcl_send_session_reset_reply (vcl_worker_t * wrk, vcl_session_t * s, int retval) { app_session_evt_t _app_evt, *app_evt = &_app_evt; session_reset_reply_msg_t *rmp; app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt, SESSION_CTRL_EVT_RESET_REPLY); rmp = (session_reset_reply_msg_t *) app_evt->evt->data; rmp->handle = s->vpp_handle; rmp->context = wrk->api_client_handle; rmp->retval = retval; app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt); } void vcl_send_session_worker_update (vcl_worker_t * wrk, vcl_session_t * s, u32 wrk_index) { app_session_evt_t _app_evt, *app_evt = &_app_evt; session_worker_update_msg_t *mp; app_alloc_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt, SESSION_CTRL_EVT_WORKER_UPDATE); mp = (session_worker_update_msg_t *) app_evt->evt->data; mp->client_index = wrk->api_client_handle; mp->handle = s->vpp_handle; mp->req_wrk_index = wrk->vpp_wrk_index; mp->wrk_index = wrk_index; app_send_ctrl_evt_to_vpp (s->vpp_evt_q, app_evt); } int vcl_send_worker_rpc (u32 dst_wrk_index, void *data, u32 data_len) { app_session_evt_t _app_evt, *app_evt = &_app_evt; session_app_wrk_rpc_msg_t *mp; vcl_worker_t *dst_wrk, *wrk; svm_msg_q_t *mq; int ret = -1; if (data_len > sizeof (mp->data)) goto done; clib_spinlock_lock (&vcm->workers_lock); dst_wrk = vcl_worker_get_if_valid (dst_wrk_index); if (!dst_wrk) goto done; wrk = vcl_worker_get_current (); mq = vcl_worker_ctrl_mq (wrk); app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_APP_WRK_RPC); mp = (session_app_wrk_rpc_msg_t *) app_evt->evt->data; mp->client_index = wrk->api_client_handle; mp->wrk_index = dst_wrk->vpp_wrk_index; clib_memcpy (mp->data, data, data_len); app_send_ctrl_evt_to_vpp (mq, app_evt); ret = 0; done: clib_spinlock_unlock (&vcm->workers_lock); return ret; } int vcl_session_transport_attr (vcl_worker_t *wrk, vcl_session_t *s, u8 is_get, transport_endpt_attr_t *attr) { app_session_evt_t _app_evt, *app_evt = &_app_evt; session_transport_attr_msg_t *mp; svm_msg_q_t *mq; f64 timeout; ASSERT (!wrk->session_attr_op); mq = s->vpp_evt_q; if (PREDICT_FALSE (!mq)) { /* FIXME: attribute should be stored and sent once session is * bound/connected to vpp */ return 0; } wrk->session_attr_op = 1; wrk->session_attr_op_rv = -1; app_alloc_ctrl_evt_to_vpp (mq, app_evt, SESSION_CTRL_EVT_TRANSPORT_ATTR); mp = (session_transport_attr_msg_t *) app_evt->evt->data; memset (mp, 0, sizeof (*mp)); mp->client_index = wrk->api_client_handle; mp->handle = s->vpp_handle; mp->is_get = is_get; mp->attr = *attr; app_send_ctrl_evt_to_vpp (mq, app_evt); timeout = clib_time_now (&wrk->clib_time) + 1; while (wrk->session_attr_op && clib_time_now (&wrk->clib_time) < timeout) vcl_flush_mq_events (); if (!wrk->session_attr_op_rv && is_get) *attr = wrk->session_attr_rv; wrk->session_attr_op = 0; return wrk->session_attr_op_rv; } static u32 vcl_session_accepted_handler (vcl_worker_t * wrk, session_accepted_msg_t * mp, u32 ls_index) { vcl_session_t *session, *listen_session; svm_msg_q_t *evt_q; session = vcl_session_alloc (wrk); listen_session = vcl_session_get (wrk, ls_index); if (listen_session->vpp_handle != mp->listener_handle) { VDBG (0, "ERROR: listener handle %lu does not match session %u", mp->listener_handle, ls_index); goto error; } if (vcl_segment_attach_session ( mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo, mp->vpp_event_queue_address, mp->mq_index, 0, session)) { VDBG (0, "session %u [0x%llx]: failed to attach fifos", session->session_index, mp->handle); goto error; } session->vpp_handle = mp->handle; session->session_state = VCL_STATE_READY; session->transport.rmt_port = mp->rmt.port; session->transport.is_ip4 = mp->rmt.is_ip4; clib_memcpy_fast (&session->transport.rmt_ip, &mp->rmt.ip, sizeof (ip46_address_t)); vcl_session_table_add_vpp_handle (wrk, mp->handle, session->session_index); session->transport.lcl_port = mp->lcl.port; session->transport.lcl_ip = mp->lcl.ip; session->session_type = listen_session->session_type; session->is_dgram = vcl_proto_is_dgram (session->session_type); session->listener_index = listen_session->session_index; listen_session->n_accepted_sessions++; vcl_evt (VCL_EVT_ACCEPT, session, listen_session, session_index); vcl_send_session_accepted_reply (session->vpp_evt_q, mp->context, session->vpp_handle, 0); return session->session_index; error: vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0), mp->vpp_event_queue_address, mp->mq_index, &evt_q); vcl_send_session_accepted_reply (evt_q, mp->context, mp->handle, VNET_API_ERROR_INVALID_ARGUMENT); vcl_session_free (wrk, session); return VCL_INVALID_SESSION_INDEX; } static u32 vcl_session_connected_handler (vcl_worker_t * wrk, session_connected_msg_t * mp) { vcl_session_t *session = 0; u32 session_index; session_index = mp->context; session = vcl_session_get (wrk, session_index); if (PREDICT_FALSE (!session)) { VERR ("vpp handle 0x%llx has no session index (%u)!", mp->handle, session_index); /* Should not happen but if it does, force vpp session cleanup */ vcl_session_t tmp_session = { .vpp_handle = mp->handle, .vpp_evt_q = 0, }; vcl_segment_attach_session ( mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo, mp->vpp_event_queue_address, mp->mq_index, 0, session); if (tmp_session.vpp_evt_q) vcl_send_session_disconnect (wrk, &tmp_session); return VCL_INVALID_SESSION_INDEX; } if (mp->retval) { VDBG (0, "session %u: connect failed! %U", session_index, format_session_error, mp->retval); session->session_state = VCL_STATE_DETACHED; session->vpp_handle = VCL_INVALID_SESSION_HANDLE; session->vpp_error = mp->retval; return session_index; } session->vpp_handle = mp->handle; /* Add to lookup table. Even if something fails, session cannot be * cleaned up prior to notifying vpp and going through the cleanup * "procedure" see @ref vcl_session_cleanup_handler */ vcl_session_table_add_vpp_handle (wrk, mp->handle, session_index); if (vcl_segment_attach_session ( mp->segment_handle, mp->server_rx_fifo, mp->server_tx_fifo, mp->vpp_event_queue_address, mp->mq_index, 0, session)) { VDBG (0, "session %u [0x%llx]: failed to attach fifos", session->session_index, session->vpp_handle); session->session_state = VCL_STATE_UPDATED; vcl_send_session_disconnect (wrk, session); return session_index; } if (mp->ct_rx_fifo) { if (vcl_segment_attach_session (mp->ct_segment_handle, mp->ct_rx_fifo, mp->ct_tx_fifo, (uword) ~0, ~0, 1, session)) { VDBG (0, "session %u [0x%llx]: failed to attach ct fifos", session->session_index, session->vpp_handle); session->session_state = VCL_STATE_UPDATED; vcl_send_session_disconnect (wrk, session); return session_index; } } session->transport.is_ip4 = mp->lcl.is_ip4; clib_memcpy_fast (&session->transport.lcl_ip, &mp->lcl.ip, sizeof (session->transport.lcl_ip)); session->transport.lcl_port = mp->lcl.port; /* Application closed session before connect reply */ if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK) && session->session_state == VCL_STATE_CLOSED) vcl_send_session_disconnect (wrk, session); else session->session_state = VCL_STATE_READY; VDBG (0, "session %u [0x%llx] connected local: %U:%u remote %U:%u", session->session_index, session->vpp_handle, vcl_format_ip46_address, &session->transport.lcl_ip, session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6, clib_net_to_host_u16 (session->transport.lcl_port), vcl_format_ip46_address, &session->transport.rmt_ip, session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6, clib_net_to_host_u16 (session->transport.rmt_port)); return session_index; } static int vcl_flag_accepted_session (vcl_session_t * session, u64 handle, u32 flags) { vcl_session_msg_t *accepted_msg; int i; for (i = 0; i < vec_len (session->accept_evts_fifo); i++) { accepted_msg = &session->accept_evts_fifo[i]; if (accepted_msg->accepted_msg.handle == handle) { accepted_msg->flags |= flags; return 1; } } return 0; } static u32 vcl_session_reset_handler (vcl_worker_t * wrk, session_reset_msg_t * reset_msg) { vcl_session_t *session; u32 sid; sid = vcl_session_index_from_vpp_handle (wrk, reset_msg->handle); session = vcl_session_get (wrk, sid); if (!session) { VDBG (0, "request to reset unknown handle 0x%llx", reset_msg->handle); return VCL_INVALID_SESSION_INDEX; } /* Caught a reset before actually accepting the session */ if (session->session_state == VCL_STATE_LISTEN) { if (!vcl_flag_accepted_session (session, reset_msg->handle, VCL_ACCEPTED_F_RESET)) VDBG (0, "session was not accepted!"); return VCL_INVALID_SESSION_INDEX; } if (session->session_state != VCL_STATE_CLOSED) session->session_state = VCL_STATE_DISCONNECT; session->flags |= (VCL_SESSION_F_RD_SHUTDOWN | VCL_SESSION_F_WR_SHUTDOWN); VDBG (0, "session %u [0x%llx]: reset", sid, reset_msg->handle); return sid; } static u32 vcl_session_bound_handler (vcl_worker_t * wrk, session_bound_msg_t * mp) { vcl_session_t *session; u32 sid = mp->context; session = vcl_session_get (wrk, sid); if (mp->retval) { VERR ("session %u [0x%llx]: bind failed: %U", sid, mp->handle, format_session_error, mp->retval); if (session) { session->session_state = VCL_STATE_DETACHED; session->vpp_handle = mp->handle; return sid; } else { VDBG (0, "session %u [0x%llx]: Invalid session index!", sid, mp->handle); return VCL_INVALID_SESSION_INDEX; } } session->vpp_handle = mp->handle; session->transport.is_ip4 = mp->lcl_is_ip4; clib_memcpy_fast (&session->transport.lcl_ip, mp->lcl_ip, sizeof (ip46_address_t)); session->transport.lcl_port = mp->lcl_port; vcl_session_table_add_listener (wrk, mp->handle, sid); session->session_state = VCL_STATE_LISTEN; if (vcl_session_is_cl (session)) { if (vcl_segment_attach_session (mp->segment_handle, mp->rx_fifo, mp->tx_fifo, mp->vpp_evt_q, mp->mq_index, 0, session)) { VDBG (0, "session %u [0x%llx]: failed to attach fifos", session->session_index, session->vpp_handle); session->session_state = VCL_STATE_DETACHED; return VCL_INVALID_SESSION_INDEX; } } VDBG (0, "session %u [0x%llx]: listen succeeded!", sid, mp->handle); return sid; } static void vcl_session_unlisten_reply_handler (vcl_worker_t * wrk, void *data) { session_unlisten_reply_msg_t *mp = (session_unlisten_reply_msg_t *) data; vcl_session_t *s; s = vcl_session_get_w_vpp_handle (wrk, mp->handle); if (!s) { VDBG (0, "Unlisten reply with wrong handle %llx", mp->handle); return; } if (s->session_state != VCL_STATE_DISCONNECT) { /* Connected udp listener */ if (s->session_type == VPPCOM_PROTO_UDP && s->session_state == VCL_STATE_CLOSED) return; VDBG (0, "Unlisten session in wrong state %llx", mp->handle); return; } if (mp->retval) VDBG (0, "ERROR: session %u [0xllx]: unlisten failed: %U", s->session_index, mp->handle, format_session_error, mp->retval); if (mp->context != wrk->wrk_index) VDBG (0, "wrong context"); vcl_session_table_del_vpp_handle (wrk, mp->handle); vcl_session_free (wrk, s); } static void vcl_session_migrated_handler (vcl_worker_t * wrk, void *data) { session_migrated_msg_t *mp = (session_migrated_msg_t *) data; vcl_session_t *s; u32 fs_index; s = vcl_session_get_w_vpp_handle (wrk, mp->handle); if (!s) { VDBG (0, "Migrated notification with wrong handle %llx", mp->handle); return; } /* Only validate if a value is provided */ if (mp->segment_handle != SESSION_INVALID_HANDLE) { fs_index = vcl_segment_table_lookup (mp->segment_handle); if (fs_index == VCL_INVALID_SEGMENT_INDEX) { VDBG (0, "segment %lx for session %u is not mounted!", mp->segment_handle, s->session_index); s->session_state = VCL_STATE_DETACHED; return; } } s->vpp_handle = mp->new_handle; vcl_segment_attach_mq (vcl_vpp_worker_segment_handle (0), mp->vpp_evt_q, mp->vpp_thread_index, &s->vpp_evt_q); vcl_session_table_del_vpp_handle (wrk, mp->handle); vcl_session_table_add_vpp_handle (wrk, mp->new_handle, s->session_index); /* Generate new tx event if we have outstanding data */ if (svm_fifo_has_event (s->tx_fifo)) app_send_io_evt_to_vpp (s->vpp_evt_q, s->tx_fifo->shr->master_session_index, SESSION_IO_EVT_TX, SVM_Q_WAIT); VDBG (0, "Migrated 0x%lx to thread %u 0x%lx", mp->handle, mp->vpp_thread_index, mp->new_handle); } static vcl_session_t * vcl_session_accepted (vcl_worker_t * wrk, session_accepted_msg_t * msg) { vcl_session_msg_t *vcl_msg; vcl_session_t *session; session = vcl_session_get_w_vpp_handle (wrk, msg->handle); if (PREDICT_FALSE (session != 0)) VWRN ("session overlap handle %lu state %u!", msg->handle, session->session_state); session = vcl_session_table_lookup_listener (wrk, msg->listener_handle); if (!session) { VERR ("couldn't find listen session: listener handle %llx", msg->listener_handle); return 0; } clib_fifo_add2 (session->accept_evts_fifo, vcl_msg); vcl_msg->flags = 0; vcl_msg->accepted_msg = *msg; /* Session handle points to listener until fully accepted by app */ vcl_session_table_add_vpp_handle (wrk, msg->handle, session->session_index); return session; } static vcl_session_t * vcl_session_disconnected_handler (vcl_worker_t * wrk, session_disconnected_msg_t * msg) { vcl_session_t *session; session = vcl_session_get_w_vpp_handle (wrk, msg->handle); if (!session) { VWRN ("request to disconnect unknown handle 0x%llx", msg->handle); return 0; } /* Late disconnect notification on a session that has been closed */ if (session->session_state == VCL_STATE_CLOSED) return 0; /* Caught a disconnect before actually accepting the session */ if (session->session_state == VCL_STATE_LISTEN) { if (!vcl_flag_accepted_session (session, msg->handle, VCL_ACCEPTED_F_CLOSED)) VDBG (0, "session was not accepted!"); return 0; } /* If not already reset change state */ if (session->session_state != VCL_STATE_DISCONNECT) session->session_state = VCL_STATE_VPP_CLOSING; return session; } int vppcom_session_shutdown (uint32_t session_handle, int how) { vcl_worker_t *wrk = vcl_worker_get_current (); vcl_session_t *session; vcl_session_state_t state; u64 vpp_handle; session = vcl_session_get_w_handle (wrk, session_handle); if (PREDICT_FALSE (!session)) return VPPCOM_EBADFD; vpp_handle = session->vpp_handle; state = session->session_state; VDBG (1, "session %u [0x%llx] state 0x%x (%s)", session->session_index, vpp_handle, state, vcl_session_state_str (state)); if (PREDICT_FALSE (state == VCL_STATE_LISTEN)) { VDBG (0, "ERROR: Cannot shutdown a listen socket!"); return VPPCOM_EBADFD; } if (how == SHUT_RD || how == SHUT_RDWR) { session->flags |= VCL_SESSION_F_RD_SHUTDOWN; if (how == SHUT_RD) return VPPCOM_OK; } session->flags |= VCL_SESSION_F_WR_SHUTDOWN; if (PREDICT_TRUE (state == VCL_STATE_READY)) { VDBG (1, "session %u [0x%llx]: sending shutdown...", session->session_index, vpp_handle); vcl_send_session_shutdown (wrk, session); } return VPPCOM_OK; } static int vppcom_session_disconnect (u32 session_handle) { vcl_worker_t *wrk = vcl_worker_get_current (); vcl_session_t *session, *listen_session; vcl_session_state_t state; u64 vpp_handle; session = vcl_session_get_w_handle (wrk, session_handle); if (!session) return VPPCOM_EBADFD; vpp_handle = session->vpp_handle; state = session->session_state; VDBG (1, "session %u [0x%llx]: disconnecting state (%s)", session->session_index, vpp_handle, vcl_session_state_str (state)); if (PREDICT_FALSE (state == VCL_STATE_LISTEN)) { VDBG (0, "ERROR: Cannot disconnect a listen socket!"); return VPPCOM_EBADFD; } if (state == VCL_STATE_VPP_CLOSING) { vcl_send_session_disconnected_reply (wrk, session, 0); VDBG (1, "session %u [0x%llx]: sending disconnect REPLY...", session->session_index, vpp_handle); } else { /* Session doesn't have an event queue yet. Probably a non-blocking * connect. Wait for the reply */ if (PREDICT_FALSE (!session->vpp_evt_q)) return VPPCOM_OK; VDBG (1, "session %u [0x%llx]: sending disconnect", session->session_index, vpp_handle); vcl_send_session_disconnect (wrk, session); } if (session->listener_index != VCL_INVALID_SESSION_INDEX) { listen_session = vcl_session_get (wrk, session->listener_index); if (listen_session) listen_session->n_accepted_sessions--; } return VPPCOM_OK; } static void vcl_session_cleanup_handler (vcl_worker_t * wrk, void *data) { session_cleanup_msg_t *msg; vcl_session_t *session; msg = (session_cleanup_msg_t *) data; session = vcl_session_get_w_vpp_handle (wrk, msg->handle); if (!session) { VWRN ("disconnect confirmed for unknown handle 0x%llx", msg->handle); return; } if (msg->type == SESSION_CLEANUP_TRANSPORT) { /* Transport was cleaned up before we confirmed close. Probably the * app is still waiting for some data that cannot be delivered. * Confirm close to make sure everything is cleaned up. * Move to undetermined state to ensure that the session is not * removed before both vpp and the app cleanup. * - If the app closes first, the session is moved to CLOSED state * and the session cleanup notification from vpp removes the * session. * - If vpp cleans up the session first, the session is moved to * DETACHED state lower and subsequently the close from the app * frees the session */ if (session->session_state == VCL_STATE_VPP_CLOSING) { vppcom_session_disconnect (vcl_session_handle (session)); session->session_state = VCL_STATE_UPDATED; } else if (session->session_state == VCL_STATE_DISCONNECT) { vcl_send_session_reset_reply (wrk, session, 0); session->session_state = VCL_STATE_UPDATED; } return; } /* VPP will reuse the handle so clean it up now */ vcl_session_table_del_vpp_handle (wrk, msg->handle); /* App did not close the connection yet so don't free it. */ if (session->session_state != VCL_STATE_CLOSED) { VDBG (0, "session %u: app did not close", session->session_index); session->session_state = VCL_STATE_DETACHED; session->vpp_handle = VCL_INVALID_SESSION_HANDLE; return; } /* Session probably tracked with epoll, disconnect not yet handled and * 1) both transport and session cleanup completed 2) app closed. Wait * until message is drained to free the session. * See @ref vcl_handle_mq_event */ if (session->flags & VCL_SESSION_F_PENDING_DISCONNECT) { session->flags |= VCL_SESSION_F_PENDING_FREE; return; } vcl_session_free (wrk, session); } static void vcl_session_req_worker_update_handler (vcl_worker_t * wrk, void *data) { session_req_worker_update_msg_t *msg; vcl_session_t *s; msg = (session_req_worker_update_msg_t *) data; s = vcl_session_get_w_vpp_handle (wrk, msg->session_handle); if (!s) return; vec_add1 (wrk->pending_session_wrk_updates, s->session_index); } static void vcl_session_worker_update_reply_handler (vcl_worker_t * wrk, void *data) { session_worker_update_reply_msg_t *msg; vcl_session_t *s; msg = (session_worker_update_reply_msg_t *) data; s = vcl_session_get_w_vpp_handle (wrk, msg->handle); if (!s) { VDBG (0, "unknown handle 0x%llx", msg->handle); return; } if (s->rx_fifo) { if (vcl_segment_attach_session (msg->segment_handle, msg->rx_fifo, msg->tx_fifo, (uword) ~0, ~0, 0, s)) { VDBG (0, "failed to attach fifos for %u", s->session_index); return; } } s->session_state = VCL_STATE_UPDATED; VDBG (0, "session %u[0x%llx] moved to worker %u", s->session_index, s->vpp_handle, wrk->wrk_index); } static int vcl_api_recv_fd (vcl_worker_t * wrk, int *fds, int n_fds) { if (vcm->cfg.vpp_app_socket_api) return vcl_sapi_recv_fds (wrk, fds, n_fds); return vcl_bapi_recv_fds (wrk, fds, n_fds); } static void vcl_session_app_add_segment_handler (vcl_worker_t * wrk, void *data) { ssvm_segment_type_t seg_type = SSVM_SEGMENT_SHM; session_app_add_segment_msg_t *msg; u64 segment_handle; int fd = -1; msg = (session_app_add_segment_msg_t *) data; if (msg->fd_flags) { vcl_api_recv_fd (wrk, &fd, 1); seg_type = SSVM_SEGMENT_MEMFD; } segment_handle = msg->segment_handle; if (segment_handle == VCL_INVALID_SEGMENT_HANDLE) { clib_warning ("invalid segment handle"); return; } if (vcl_segment_attach (segment_handle, (char *) msg->segment_name, seg_type, fd)) { VDBG (0, "vcl_segment_attach ('%s') failed", msg->segment_name); return; } VDBG (1, "mapped new segment '%s' size %d", msg->segment_name, msg->segment_size); } static void vcl_session_app_del_segment_handler (vcl_worker_t * wrk, void *data) { session_app_del_segment_msg_t *msg = (session_app_del_segment_msg_t *) data; vcl_segment_detach (msg->segment_handle); VDBG (1, "Unmapped segment: %d", msg->segment_handle); } static void vcl_worker_rpc_handler (vcl_worker_t * wrk, void *data) { if (!vcm->wrk_rpc_fn) return; (vcm->wrk_rpc_fn) (((session_app_wrk_rpc_msg_t *) data)->data); } static void vcl_session_transport_attr_reply_handler (vcl_worker_t *wrk, void *data) { session_transport_attr_reply_msg_t *mp; if (!wrk->session_attr_op) return; mp = (session_transport_attr_reply_msg_t *) data; wrk->session_attr_op_rv = mp->retval; wrk->session_attr_op = 0; wrk->session_attr_rv = mp->attr; } static int vcl_handle_mq_event (vcl_worker_t * wrk, session_event_t * e) { session_disconnected_msg_t *disconnected_msg; session_connected_msg_t *connected_msg; session_reset_msg_t *reset_msg; session_event_t *ecpy; vcl_session_t *s; u32 sid; switch (e->event_type) { case SESSION_IO_EVT_RX: case SESSION_IO_EVT_TX: s = vcl_session_get (wrk, e->session_index); if (!s || !vcl_session_is_open (s)) break; vec_add1 (wrk->unhandled_evts_vector, *e); break; case SESSION_CTRL_EVT_BOUND: /* We can only wait for only one listen so not postponed */ vcl_session_bound_handler (wrk, (session_bound_msg_t *) e->data); break; case SESSION_CTRL_EVT_ACCEPTED: s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data); if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK)) { vec_add2 (wrk->unhandled_evts_vector, ecpy, 1); *ecpy = *e; ecpy->postponed = 1; ecpy->session_index = s->session_index; } break; case SESSION_CTRL_EVT_CONNECTED: connected_msg = (session_connected_msg_t *) e->data; sid = vcl_session_connected_handler (wrk, connected_msg); if (!(s = vcl_session_get (wrk, sid))) break; if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK)) { vec_add2 (wrk->unhandled_evts_vector, ecpy, 1); *ecpy = *e; ecpy->postponed = 1; ecpy->session_index = s->session_index; } break; case SESSION_CTRL_EVT_DISCONNECTED: disconnected_msg = (session_disconnected_msg_t *) e->data; if (!(s = vcl_session_get_w_vpp_handle (wrk, disconnected_msg->handle))) break; if (s->session_state == VCL_STATE_CLOSED) break; if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK)) { s->session_state = VCL_STATE_VPP_CLOSING; s->flags |= VCL_SESSION_F_PENDING_DISCONNECT; vec_add2 (wrk->unhandled_evts_vector, ecpy, 1); *ecpy = *e; ecpy->postponed = 1; ecpy->session_index = s->session_index; break; } if (!(s = vcl_session_disconnected_handler (wrk, disconnected_msg))) break; VDBG (0, "disconnected session %u [0x%llx]", s->session_index, s->vpp_handle); break; case SESSION_CTRL_EVT_RESET: reset_msg = (session_reset_msg_t *) e->data; if (!(s = vcl_session_get_w_vpp_handle (wrk, reset_msg->handle))) break; if (s->session_state == VCL_STATE_CLOSED) break; if (vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK)) { s->flags |= VCL_SESSION_F_PENDING_DISCONNECT; s->session_state = VCL_STATE_DISCONNECT; s->flags |= (VCL_SESSION_F_RD_SHUTDOWN | VCL_SESSION_F_WR_SHUTDOWN); vec_add2 (wrk->unhandled_evts_vector, ecpy, 1); *ecpy = *e; ecpy->postponed = 1; ecpy->session_index = s->session_index; break; } vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data); break; case SESSION_CTRL_EVT_UNLISTEN_REPLY: vcl_session_unlisten_reply_handler (wrk, e->data); break; case SESSION_CTRL_EVT_MIGRATED: vcl_session_migrated_handler (wrk, e->data); break; case SESSION_CTRL_EVT_CLEANUP: vcl_session_cleanup_handler (wrk, e->data); break; case SESSION_CTRL_EVT_REQ_WORKER_UPDATE: vcl_session_req_worker_update_handler (wrk, e->data); break; case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY: vcl_session_worker_update_reply_handler (wrk, e->data); break; case SESSION_CTRL_EVT_APP_ADD_SEGMENT: vcl_session_app_add_segment_handler (wrk, e->data); break; case SESSION_CTRL_EVT_APP_DEL_SEGMENT: vcl_session_app_del_segment_handler (wrk, e->data); break; case SESSION_CTRL_EVT_APP_WRK_RPC: vcl_worker_rpc_handler (wrk, e->data); break; case SESSION_CTRL_EVT_TRANSPORT_ATTR_REPLY: vcl_session_transport_attr_reply_handler (wrk, e->data); break; default: clib_warning ("unhandled %u", e->event_type); } return VPPCOM_OK; } static int vppcom_wait_for_session_state_change (u32 session_index, vcl_session_state_t state, f64 wait_for_time) { vcl_worker_t *wrk = vcl_worker_get_current (); f64 timeout = clib_time_now (&wrk->clib_time) + wait_for_time; vcl_session_t *volatile session; svm_msg_q_msg_t msg; session_event_t *e; do { session = vcl_session_get (wrk, session_index); if (PREDICT_FALSE (!session)) { return VPPCOM_EBADFD; } if (session->session_state == state) { return VPPCOM_OK; } if (session->session_state == VCL_STATE_DETACHED) { return VPPCOM_ECONNREFUSED; } if (svm_msg_q_sub (wrk->app_event_queue, &msg, SVM_Q_NOWAIT, 0)) { usleep (100); continue; } e = svm_msg_q_msg_data (wrk->app_event_queue, &msg); vcl_handle_mq_event (wrk, e); svm_msg_q_free_msg (wrk->app_event_queue, &msg); } while (clib_time_now (&wrk->clib_time) < timeout); VDBG (0, "timeout waiting for state 0x%x (%s)", state, vcl_session_state_str (state)); vcl_evt (VCL_EVT_SESSION_TIMEOUT, session, session_state); return VPPCOM_ETIMEDOUT; } static void vcl_handle_pending_wrk_updates (vcl_worker_t * wrk) { vcl_session_state_t state; vcl_session_t *s; u32 *sip; if (PREDICT_TRUE (vec_len (wrk->pending_session_wrk_updates) == 0)) return; vec_foreach (sip, wrk->pending_session_wrk_updates) { s = vcl_session_get (wrk, *sip); vcl_send_session_worker_update (wrk, s, wrk->wrk_index); state = s->session_state; vppcom_wait_for_session_state_change (s->session_index, VCL_STATE_UPDATED, 5); s->session_state = state; } vec_reset_length (wrk->pending_session_wrk_updates); } void vcl_worker_flush_mq_events (vcl_worker_t *wrk) { svm_msg_q_msg_t *msg; session_event_t *e; svm_msg_q_t *mq; int i; mq = wrk->app_event_queue; vcl_mq_dequeue_batch (wrk, mq, ~0); for (i = 0; i < vec_len (wrk->mq_msg_vector); i++) { msg = vec_elt_at_index (wrk->mq_msg_vector, i); e = svm_msg_q_msg_data (mq, msg); vcl_handle_mq_event (wrk, e); svm_msg_q_free_msg (mq, msg); } vec_reset_length (wrk->mq_msg_vector); vcl_handle_pending_wrk_updates (wrk); } void vcl_flush_mq_events (void) { vcl_worker_flush_mq_events (vcl_worker_get_current ()); } static int vppcom_session_unbind (u32 session_handle) { vcl_worker_t *wrk = vcl_worker_get_current (); session_accepted_msg_t *accepted_msg; vcl_session_t *session = 0; vcl_session_msg_t *evt; session = vcl_session_get_w_handle (wrk, session_handle); if (!session) return VPPCOM_EBADFD; /* Flush pending accept events, if any */ while (clib_fifo_elts (session->accept_evts_fifo)) { clib_fifo_sub2 (session->accept_evts_fifo, evt); accepted_msg = &evt->accepted_msg; vcl_session_table_del_vpp_handle (wrk, accepted_msg->handle); vcl_send_session_accepted_reply (session->vpp_evt_q, accepted_msg->context, accepted_msg->handle, -1); } clib_fifo_free (session->accept_evts_fifo); vcl_send_session_unlisten (wrk, session); VDBG (1, "session %u [0x%llx]: sending unbind!", session->session_index, session->vpp_handle); vcl_evt (VCL_EVT_UNBIND, session); session->vpp_handle = ~0; session->session_state = VCL_STATE_DISCONNECT; return VPPCOM_OK; } /** * Handle app exit * * Notify vpp of the disconnect and mark the worker as free. If we're the * last worker, do a full cleanup otherwise, since we're probably a forked * child, avoid syscalls as much as possible. We might've lost privileges. */ void vppcom_app_exit (void) { if (!pool_elts (vcm->workers)) return; vcl_worker_cleanup (vcl_worker_get_current (), 1 /* notify vpp */ ); vcl_set_worker_index (~0); vcl_elog_stop (vcm); } static int vcl_api_attach (void) { if (vcm->cfg.vpp_app_socket_api) return vcl_sapi_attach (); return vcl_bapi_attach (); } int vcl_is_first_reattach_to_execute () { if (vcm->reattach_count == 0) return 1; return 0; } void vcl_set_reattach_counter () { ++vcm->reattach_count; if (vcm->reattach_count == vec_len (vcm->workers)) vcm->reattach_count = 0; } /** * Reattach vcl to vpp after it has previously been disconnected. * * The logic should be: * - first worker to hit `vcl_api_retry_attach` should attach to vpp, * to reproduce the `vcl_api_attach` in `vppcom_app_create`. * - the rest of the workers should `reproduce vcl_worker_register_with_vpp` * from `vppcom_worker_register` since they were already allocated. */ static void vcl_api_retry_attach (vcl_worker_t *wrk) { vcl_session_t *s; clib_spinlock_lock (&vcm->workers_lock); if (vcl_is_first_reattach_to_execute ()) { if (vcl_api_attach ()) { clib_spinlock_unlock (&vcm->workers_lock); return; } vcl_set_reattach_counter (); clib_spinlock_unlock (&vcm->workers_lock); } else { vcl_set_reattach_counter (); clib_spinlock_unlock (&vcm->workers_lock); vcl_worker_register_with_vpp (); } /* Treat listeners as configuration that needs to be re-added to vpp */ pool_foreach (s, wrk->sessions) { if (s->flags & VCL_SESSION_F_IS_VEP) continue; if (s->session_state == VCL_STATE_LISTEN_NO_MQ) vppcom_session_listen (vcl_session_handle (s), 10); else VDBG (0, "internal error: unexpected state %d", s->session_state); } } static void vcl_api_handle_disconnect (vcl_worker_t *wrk) { wrk->api_client_handle = ~0; vcl_worker_detach_sessions (wrk); } static void vcl_api_detach (vcl_worker_t * wrk) { if (wrk->api_client_handle == ~0) return; vcl_send_app_detach (wrk); if (vcm->cfg.vpp_app_socket_api) return vcl_sapi_detach (wrk); return vcl_bapi_disconnect_from_vpp (); } /* * VPPCOM Public API functions */ int vppcom_app_create (const char *app_name) { vppcom_cfg_t *vcl_cfg = &vcm->cfg; int rv; if (vcm->is_init) { VDBG (1, "already initialized"); return VPPCOM_EEXIST; } vcm->is_init = 1; vppcom_cfg (&vcm->cfg); vcl_cfg = &vcm->cfg; vcm->main_cpu = pthread_self (); vcm->main_pid = getpid (); vcm->app_name = format (0, "%s", app_name); fifo_segment_main_init (&vcm->segment_main, (uword) ~0, 20 /* timeout in secs */); pool_alloc (vcm->workers, vcl_cfg->max_workers); clib_spinlock_init (&vcm->workers_lock); clib_rwlock_init (&vcm->segment_table_lock); atexit (vppcom_app_exit); vcl_elog_init (vcm); /* Allocate default worker */ vcl_worker_alloc_and_init (); if ((rv = vcl_api_attach ())) { vppcom_app_destroy (); return rv; } VDBG (0, "app_name '%s', my_client_index %d (0x%x)", app_name, vcm->workers[0].api_client_handle, vcm->workers[0].api_client_handle); return VPPCOM_OK; } void vppcom_app_destroy (void) { vcl_worker_t *wrk, *current_wrk; void *heap; if (!pool_elts (vcm->workers)) return; vcl_evt (VCL_EVT_DETACH, vcm); current_wrk = vcl_worker_get_current (); /* *INDENT-OFF* */ pool_foreach (wrk, vcm->workers) { if (current_wrk != wrk) vcl_worker_cleanup (wrk, 0 /* notify vpp */ ); } /* *INDENT-ON* */ vcl_api_detach (current_wrk); vcl_worker_cleanup (current_wrk, 0 /* notify vpp */ ); vcl_set_worker_index (~0); vcl_elog_stop (vcm); /* * Free the heap and fix vcm */ heap = clib_mem_get_heap (); munmap (clib_mem_get_heap_base (heap), clib_mem_get_heap_size (heap)); vcm = &_vppcom_main; vcm->is_init = 0; } int vppcom_session_create (u8 proto, u8 is_nonblocking) { vcl_worker_t *wrk = vcl_worker_get_current (); vcl_session_t *session; session = vcl_session_alloc (wrk); session->session_type = proto; session->session_state = VCL_STATE_CLOSED; session->vpp_handle = ~0; session->is_dgram = vcl_proto_is_dgram (proto); session->vpp_error = SESSION_E_NONE; if (is_nonblocking) vcl_session_set_attr (session, VCL_SESS_ATTR_NONBLOCK); vcl_evt (VCL_EVT_CREATE, session, session_type, session->session_state, is_nonblocking, session_index); VDBG (0, "created session %u", session->session_index); return vcl_session_handle (session); } static void vcl_epoll_lt_add (vcl_worker_t *wrk, vcl_session_t *s) { vcl_session_t *cur, *prev; if (wrk->ep_lt_current == VCL_INVALID_SESSION_INDEX) { wrk->ep_lt_current = s->session_index; s->vep.lt_next = s->session_index; s->vep.lt_prev = s->session_index; return; } cur = vcl_session_get (wrk, wrk->ep_lt_current); prev = vcl_session_get (wrk, cur->vep.lt_prev); prev->vep.lt_next = s->session_index; s->vep.lt_prev = prev->session_index; s->vep.lt_next = cur->session_index; cur->vep.lt_prev = s->session_index; } static void vcl_epoll_lt_del (vcl_worker_t *wrk, vcl_session_t *s) { vcl_session_t *prev, *next; if (s->vep.lt_next == s->session_index) { wrk->ep_lt_current = VCL_INVALID_SESSION_INDEX; s->vep.lt_next = VCL_INVALID_SESSION_INDEX; return; } prev = vcl_session_get (wrk, s->vep.lt_prev); next = vcl_session_get (wrk, s->vep.lt_next); prev->vep.lt_next = next->session_index; next->vep.lt_prev = prev->session_index; if (s->session_index == wrk->ep_lt_current) wrk->ep_lt_current = s->vep.lt_next; s->vep.lt_next = VCL_INVALID_SESSION_INDEX; } int vcl_session_cleanup (vcl_worker_t * wrk, vcl_session_t * s, vcl_session_handle_t sh, u8 do_disconnect) { int rv = VPPCOM_OK; VDBG (1, "session %u [0x%llx] closing", s->session_index, s->vpp_handle); if (s->flags & VCL_SESSION_F_IS_VEP) { u32 next_sh = s->vep.next_sh; while (next_sh != ~0) { rv = vppcom_epoll_ctl (sh, EPOLL_CTL_DEL, next_sh, 0); if (PREDICT_FALSE (rv < 0)) VDBG (0, "vpp handle 0x%llx, sh %u: EPOLL_CTL_DEL vep_idx %u" " failed! rv %d (%s)", s->vpp_handle, next_sh, s->vep.vep_sh, rv, vppcom_retval_str (rv)); next_sh = s->vep.next_sh; } goto free_session; } if (s->flags & VCL_SESSION_F_IS_VEP_SESSION) { rv = vppcom_epoll_ctl (s->vep.vep_sh, EPOLL_CTL_DEL, sh, 0); if (rv < 0) VDBG (0, "session %u [0x%llx]: EPOLL_CTL_DEL vep_idx %u " "failed! rv %d (%s)", s->session_index, s->vpp_handle, s->vep.vep_sh, rv, vppcom_retval_str (rv)); } if (!do_disconnect) { VDBG (1, "session %u [0x%llx] disconnect skipped", s->session_index, s->vpp_handle); goto cleanup; } if (s->session_state == VCL_STATE_LISTEN) { rv = vppcom_session_unbind (sh); if (PREDICT_FALSE (rv < 0)) VDBG (0, "session %u [0x%llx]: listener unbind failed! " "rv %d (%s)", s->session_index, s->vpp_handle, rv, vppcom_retval_str (rv)); return rv; } else if (vcl_session_is_ready (s) || (vcl_session_is_connectable_listener (wrk, s))) { rv = vppcom_session_disconnect (sh); if (PREDICT_FALSE (rv < 0)) VDBG (0, "ERROR: session %u [0x%llx]: disconnect failed!" " rv %d (%s)", s->session_index, s->vpp_handle, rv, vppcom_retval_str (rv)); } else if (s->session_state == VCL_STATE_DISCONNECT) { vcl_send_session_reset_reply (wrk, s, 0); } else if (s->session_state == VCL_STATE_DETACHED) { VDBG (0, "vpp freed session %d before close", s->session_index); if (!(s->flags & VCL_SESSION_F_PENDING_DISCONNECT)) goto free_session; /* Disconnect/reset messages pending but vpp transport and session * cleanups already done. Free only after messages drained. */ s->flags |= VCL_SESSION_F_PENDING_FREE; } s->session_state = VCL_STATE_CLOSED; /* Session is removed only after vpp confirms the disconnect */ return rv; cleanup: vcl_session_table_del_vpp_handle (wrk, s->vpp_handle); free_session: vcl_session_free (wrk, s); vcl_evt (VCL_EVT_CLOSE, s, rv); return rv; } int vppcom_session_close (uint32_t session_handle) { vcl_worker_t *wrk = vcl_worker_get_current (); vcl_session_t *session; session = vcl_session_get_w_handle (wrk, session_handle); if (!session) return VPPCOM_EBADFD; return vcl_session_cleanup (wrk, session, session_handle, 1 /* do_disconnect */ ); } int vppcom_session_bind (uint32_t session_handle, vppcom_endpt_t * ep) { vcl_worker_t *wrk = vcl_worker_get_current (); vcl_session_t *session = 0; if (!ep || !ep->ip) return VPPCOM_EINVAL; session = vcl_session_get_w_handle (wrk, session_handle); if (!session) return VPPCOM_EBADFD; if (session->flags & VCL_SESSION_F_IS_VEP) { VDBG (0, "ERROR: cannot bind to epoll session %u!", session->session_index); return VPPCOM_EBADFD; } session->transport.is_ip4 = ep->is_ip4; if (ep->is_ip4) clib_memcpy_fast (&session->transport.lcl_ip.ip4, ep->ip, sizeof (ip4_address_t)); else clib_memcpy_fast (&session->transport.lcl_ip.ip6, ep->ip, sizeof (ip6_address_t)); session->transport.lcl_port = ep->port; VDBG (0, "session %u handle %u: binding to local %s address %U port %u, " "proto %s", session->session_index, session_handle, session->transport.is_ip4 ? "IPv4" : "IPv6", vcl_format_ip46_address, &session->transport.lcl_ip, session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6, clib_net_to_host_u16 (session->transport.lcl_port), vppcom_proto_str (session->session_type)); vcl_evt (VCL_EVT_BIND, session); if (session->session_type == VPPCOM_PROTO_UDP) vppcom_session_listen (session_handle, 10); return VPPCOM_OK; } int vppcom_session_listen (uint32_t listen_sh, uint32_t q_len) { vcl_worker_t *wrk = vcl_worker_get_current (); vcl_session_t *listen_session = 0; u64 listen_vpp_handle; int rv; listen_session = vcl_session_get_w_handle (wrk, listen_sh); if (!listen_session || (listen_session->flags & VCL_SESSION_F_IS_VEP)) return VPPCOM_EBADFD; listen_vpp_handle = listen_session->vpp_handle; if (listen_session->session_state == VCL_STATE_LISTEN) { VDBG (0, "session %u [0x%llx]: already in listen state!", listen_sh, listen_vpp_handle); return VPPCOM_OK; } VDBG (0, "session %u: sending vpp listen request...", listen_sh); /* * Send listen request to vpp and wait for reply */ vcl_send_session_listen (wrk, listen_session); rv = vppcom_wait_for_session_state_change (listen_session->session_index, VCL_STATE_LISTEN, vcm->cfg.session_timeout); if (PREDICT_FALSE (rv)) { listen_session = vcl_session_get_w_handle (wrk, listen_sh); VDBG (0, "session %u [0x%llx]: listen failed! returning %d (%s)", listen_sh, listen_session->vpp_handle, rv, vppcom_retval_str (rv)); return rv; } return VPPCOM_OK; } static int validate_args_session_accept_ (vcl_worker_t * wrk, vcl_session_t * ls) { if (ls->flags & VCL_SESSION_F_IS_VEP) { VDBG (0, "ERROR: cannot accept on epoll session %u!", ls->session_index); return VPPCOM_EBADFD; } if ((ls->session_state != VCL_STATE_LISTEN) && (!vcl_session_is_connectable_listener (wrk, ls))) { VDBG (0, "ERROR: session [0x%llx]: not in listen state! state 0x%x" " (%s)", ls->vpp_handle, ls->session_state, vcl_session_state_str (ls->session_state)); return VPPCOM_EBADFD; } return VPPCOM_OK; } int vppcom_unformat_proto (uint8_t * proto, char *proto_str) { if (!strcmp (proto_str, "TCP")) *proto = VPPCOM_PROTO_TCP; else if (!strcmp (proto_str, "tcp")) *proto = VPPCOM_PROTO_TCP; else if (!strcmp (proto_str, "UDP")) *proto = VPPCOM_PROTO_UDP; else if (!strcmp (proto_str, "udp")) *proto = VPPCOM_PROTO_UDP; else if (!strcmp (proto_str, "TLS")) *proto = VPPCOM_PROTO_TLS; else if (!strcmp (proto_str, "tls")) *proto = VPPCOM_PROTO_TLS; else if (!strcmp (proto_str, "QUIC")) *proto = VPPCOM_PROTO_QUIC; else if (!strcmp (proto_str, "quic")) *proto = VPPCOM_PROTO_QUIC; else if (!strcmp (proto_str, "DTLS")) *proto = VPPCOM_PROTO_DTLS; else if (!strcmp (proto_str, "dtls")) *proto = VPPCOM_PROTO_DTLS; else if (!strcmp (proto_str, "SRTP")) *proto = VPPCOM_PROTO_SRTP; else if (!strcmp (proto_str, "srtp")) *proto = VPPCOM_PROTO_SRTP; else return 1; return 0; } int vppcom_session_accept (uint32_t listen_session_handle, vppcom_endpt_t * ep, uint32_t flags) { u32 client_session_index = ~0, listen_session_index, accept_flags = 0; vcl_worker_t *wrk = vcl_worker_get_current (); session_accepted_msg_t accepted_msg; vcl_session_t *listen_session = 0; vcl_session_t *client_session = 0; vcl_session_msg_t *evt; u8 is_nonblocking; int rv; again: listen_session = vcl_session_get_w_handle (wrk, listen_session_handle); if (!listen_session) return VPPCOM_EBADFD; listen_session_index = listen_session->session_index; if ((rv = validate_args_session_accept_ (wrk, listen_session))) return rv; if (clib_fifo_elts (listen_session->accept_evts_fifo)) { clib_fifo_sub2 (listen_session->accept_evts_fifo, evt); accept_flags = evt->flags; accepted_msg = evt->accepted_msg; goto handle; } is_nonblocking = vcl_session_has_attr (listen_session, VCL_SESS_ATTR_NONBLOCK); while (1) { if (svm_msg_q_is_empty (wrk->app_event_queue) && is_nonblocking) return VPPCOM_EAGAIN; svm_msg_q_wait (wrk->app_event_queue, SVM_MQ_WAIT_EMPTY); vcl_worker_flush_mq_events (wrk); goto again; } handle: client_session_index = vcl_session_accepted_handler (wrk, &accepted_msg, listen_session_index); if (client_session_index == VCL_INVALID_SESSION_INDEX) return VPPCOM_ECONNABORTED; listen_session = vcl_session_get (wrk, listen_session_index); client_session = vcl_session_get (wrk, client_session_index); if (flags & O_NONBLOCK) vcl_session_set_attr (client_session, VCL_SESS_ATTR_NONBLOCK); VDBG (1, "listener %u [0x%llx]: Got a connect request! session %u [0x%llx]," " flags %d, is_nonblocking %u", listen_session->session_index, listen_session->vpp_handle, client_session_index, client_session->vpp_handle, flags, vcl_session_has_attr (client_session, VCL_SESS_ATTR_NONBLOCK)); if (ep) { ep->is_ip4 = client_session->transport.is_ip4; ep->port = client_session->transport.rmt_port; if (client_session->transport.is_ip4) clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip4, sizeof (ip4_address_t)); else clib_memcpy_fast (ep->ip, &client_session->transport.rmt_ip.ip6, sizeof (ip6_address_t)); } VDBG (0, "listener %u [0x%llx] accepted %u [0x%llx] peer: %U:%u " "local: %U:%u", listen_session_handle, listen_session->vpp_handle, client_session_index, client_session->vpp_handle, vcl_format_ip46_address, &client_session->transport.rmt_ip, client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6, clib_net_to_host_u16 (client_session->transport.rmt_port), vcl_format_ip46_address, &client_session->transport.lcl_ip, client_session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6, clib_net_to_host_u16 (client_session->transport.lcl_port)); vcl_evt (VCL_EVT_ACCEPT, client_session, listen_session, client_session_index); /* * Session might have been closed already */ if (accept_flags) { if (accept_flags & VCL_ACCEPTED_F_CLOSED) client_session->session_state = VCL_STATE_VPP_CLOSING; else if (accept_flags & VCL_ACCEPTED_F_RESET) client_session->session_state = VCL_STATE_DISCONNECT; } return vcl_session_handle (client_session); } int vppcom_session_connect (uint32_t session_handle, vppcom_endpt_t * server_ep) { vcl_worker_t *wrk = vcl_worker_get_current (); vcl_session_t *session = 0; u32 session_index; int rv; session = vcl_session_get_w_handle (wrk, session_handle); if (!session) return VPPCOM_EBADFD; session_index = session->session_index; if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP)) { VWRN ("cannot connect epoll session %u!", session->session_index); return VPPCOM_EBADFD; } if (PREDICT_FALSE (vcl_session_is_ready (session))) { VDBG (0, "session %u [0x%llx]: already connected to %U:%d proto %s," " state (%s)", session->session_index, session->vpp_handle, vcl_format_ip46_address, &session->transport.rmt_ip, session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6, clib_net_to_host_u16 (session->transport.rmt_port), vppcom_proto_str (session->session_type), vcl_session_state_str (session->session_state)); return VPPCOM_OK; } /* Attempt to connect a connectionless listener */ if (PREDICT_FALSE (session->session_state == VCL_STATE_LISTEN)) { if (session->session_type != VPPCOM_PROTO_UDP) return VPPCOM_EINVAL; vcl_send_session_unlisten (wrk, session); session->session_state = VCL_STATE_CLOSED; } session->transport.is_ip4 = server_ep->is_ip4; vcl_ip_copy_from_ep (&session->transport.rmt_ip, server_ep); session->transport.rmt_port = server_ep->port; session->parent_handle = VCL_INVALID_SESSION_HANDLE; session->flags |= VCL_SESSION_F_CONNECTED; VDBG (0, "session %u: connecting to peer %U:%d proto %s", session->session_index, vcl_format_ip46_address, &session->transport.rmt_ip, session->transport.is_ip4 ? IP46_TYPE_IP4 : IP46_TYPE_IP6, clib_net_to_host_u16 (session->transport.rmt_port), vppcom_proto_str (session->session_type)); vcl_send_session_connect (wrk, session); if (vcl_session_has_attr (session, VCL_SESS_ATTR_NONBLOCK)) { /* State set to STATE_UPDATED to ensure the session is not assumed * to be ready and to also allow the app to close it prior to vpp's * connected reply. */ session->session_state = VCL_STATE_UPDATED; return VPPCOM_EINPROGRESS; } /* * Wait for reply from vpp if blocking */ rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY, vcm->cfg.session_timeout); session = vcl_session_get (wrk, session_index); VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index, session->vpp_handle, rv ? "failed" : "succeeded"); return rv; } int vppcom_session_stream_connect (uint32_t session_handle, uint32_t parent_session_handle) { vcl_worker_t *wrk = vcl_worker_get_current (); vcl_session_t *session, *parent_session; u32 session_index, parent_session_index; int rv; session = vcl_session_get_w_handle (wrk, session_handle); if (!session) return VPPCOM_EBADFD; parent_session = vcl_session_get_w_handle (wrk, parent_session_handle); if (!parent_session) return VPPCOM_EBADFD; session_index = session->session_index; parent_session_index = parent_session->session_index; if (PREDICT_FALSE (session->flags & VCL_SESSION_F_IS_VEP)) { VDBG (0, "ERROR: cannot connect epoll session %u!", session->session_index); return VPPCOM_EBADFD; } if (PREDICT_FALSE (vcl_session_is_ready (session))) { VDBG (0, "session handle %u [0x%llx]: session already " "connected to session %u [0x%llx] proto %s, state 0x%x (%s)", session_handle, session->vpp_handle, parent_session_handle, parent_session->vpp_handle, vppcom_proto_str (session->session_type), session->session_state, vcl_session_state_str (session->session_state)); return VPPCOM_OK; } /* Connect to quic session specifics */ session->transport.is_ip4 = parent_session->transport.is_ip4; session->transport.rmt_ip.ip4.as_u32 = (uint32_t) 1; session->transport.rmt_port = 0; session->parent_handle = parent_session->vpp_handle; VDBG (0, "session handle %u: connecting to session %u [0x%llx]", session_handle, parent_session_handle, parent_session->vpp_handle); /* * Send connect request and wait for reply from vpp */ vcl_send_session_connect (wrk, session); rv = vppcom_wait_for_session_state_change (session_index, VCL_STATE_READY, vcm->cfg.session_timeout); session->listener_index = parent_session_index; parent_session = vcl_session_get_w_handle (wrk, parent_session_handle); if (parent_session) parent_session->n_accepted_sessions++; session = vcl_session_get (wrk, session_index); VDBG (0, "session %u [0x%llx]: connect %s!", session->session_index, session->vpp_handle, rv ? "failed" : "succeeded"); return rv; } static inline int vppcom_session_read_internal (uint32_t session_handle, void *buf, int n, u8 peek) { vcl_worker_t *wrk = vcl_worker_get_current (); int rv, n_read = 0, is_nonblocking; vcl_session_t *s = 0; svm_fifo_t *rx_fifo; session_event_t *e; svm_msg_q_t *mq; u8 is_ct; if (PREDICT_FALSE (!buf)) return VPPCOM_EFAULT; s = vcl_session_get_w_handle (wrk, session_handle); if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP))) return VPPCOM_EBADFD; if (PREDICT_FALSE (!vcl_session_is_open (s))) { VDBG (0, "session %u[0x%llx] is not open! state 0x%x (%s)", s->session_index, s->vpp_handle, s->session_state, vcl_session_state_str (s->session_state)); return vcl_session_closed_error (s); } if (PREDICT_FALSE (s->flags & VCL_SESSION_F_RD_SHUTDOWN)) { /* Vpp would ack the incoming data and enqueue it for reading. * So even if SHUT_RD is set, we can still read() the data if * the session is ready. */ if (!vcl_session_read_ready (s)) { return 0; } } is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK); is_ct = vcl_session_is_ct (s); mq = wrk->app_event_queue; rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo; s->flags &= ~VCL_SESSION_F_HAS_RX_EVT; if (svm_fifo_is_empty_cons (rx_fifo)) { if (is_nonblocking) { if (vcl_session_is_closing (s)) return vcl_session_closing_error (s); if (is_ct) svm_fifo_unset_event (s->rx_fifo); svm_fifo_unset_event (rx_fifo); return VPPCOM_EWOULDBLOCK; } while (svm_fifo_is_empty_cons (rx_fifo)) { if (vcl_session_is_closing (s)) return vcl_session_closing_error (s); if (is_ct) svm_fifo_unset_event (s->rx_fifo); svm_fifo_unset_event (rx_fifo); svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY); vcl_worker_flush_mq_events (wrk); } } read_again: if (s->is_dgram) rv = app_recv_dgram_raw (rx_fifo, buf, n, &s->transport, 0, peek); else rv = app_recv_stream_raw (rx_fifo, buf, n, 0, peek); ASSERT (rv >= 0); if (peek) return rv; n_read += rv; if (svm_fifo_is_empty_cons (rx_fifo)) { if (is_ct) svm_fifo_unset_event (s->rx_fifo); svm_fifo_unset_event (rx_fifo); if (!svm_fifo_is_empty_cons (rx_fifo) && svm_fifo_set_event (rx_fifo) && is_nonblocking) { vec_add2 (wrk->unhandled_evts_vector, e, 1); e->event_type = SESSION_IO_EVT_RX; e->session_index = s->session_index; } } else if (PREDICT_FALSE (rv < n && !s->is_dgram)) { /* More data enqueued while reading. Try to drain it * or fill the buffer. Avoid doing that for dgrams */ buf += rv; n -= rv; goto read_again; } if (PREDICT_FALSE (svm_fifo_needs_deq_ntf (rx_fifo, n_read))) { svm_fifo_clear_deq_ntf (rx_fifo); app_send_io_evt_to_vpp (s->vpp_evt_q, s->rx_fifo->shr->master_session_index, SESSION_IO_EVT_RX, SVM_Q_WAIT); } VDBG (2, "session %u[0x%llx]: read %d bytes from (%p)", s->session_index, s->vpp_handle, n_read, rx_fifo); return n_read; } int vppcom_session_read (uint32_t session_handle, void *buf, size_t n) { return (vppcom_session_read_internal (session_handle, buf, n, 0)); } static int vppcom_session_peek (uint32_t session_handle, void *buf, int n) { return (vppcom_session_read_internal (session_handle, buf, n, 1)); } int vppcom_session_read_segments (uint32_t session_handle, vppcom_data_segment_t * ds, uint32_t n_segments, uint32_t max_bytes) { vcl_worker_t *wrk = vcl_worker_get_current (); int n_read = 0, is_nonblocking; vcl_session_t *s = 0; svm_fifo_t *rx_fifo; svm_msg_q_t *mq; u8 is_ct; s = vcl_session_get_w_handle (wrk, session_handle); if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP))) return VPPCOM_EBADFD; if (PREDICT_FALSE (!vcl_session_is_open (s))) return vcl_session_closed_error (s); is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK); is_ct = vcl_session_is_ct (s); mq = wrk->app_event_queue; rx_fifo = is_ct ? s->ct_rx_fifo : s->rx_fifo; s->flags &= ~VCL_SESSION_F_HAS_RX_EVT; if (svm_fifo_is_empty_cons (rx_fifo)) { if (is_nonblocking) { if (is_ct) svm_fifo_unset_event (s->rx_fifo); svm_fifo_unset_event (rx_fifo); return VPPCOM_EWOULDBLOCK; } while (svm_fifo_is_empty_cons (rx_fifo)) { if (vcl_session_is_closing (s)) return vcl_session_closing_error (s); if (is_ct) svm_fifo_unset_event (s->rx_fifo); svm_fifo_unset_event (rx_fifo); svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY); vcl_worker_flush_mq_events (wrk); } } n_read = svm_fifo_segments (rx_fifo, s->rx_bytes_pending, (svm_fifo_seg_t *) ds, &n_segments, max_bytes); if (n_read < 0) return VPPCOM_EAGAIN; if (svm_fifo_max_dequeue_cons (rx_fifo) == n_read) { if (is_ct) svm_fifo_unset_event (s->rx_fifo); svm_fifo_unset_event (rx_fifo); if (svm_fifo_max_dequeue_cons (rx_fifo) != n_read && svm_fifo_set_event (rx_fifo) && vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK)) { session_event_t *e; vec_add2 (wrk->unhandled_evts_vector, e, 1); e->event_type = SESSION_IO_EVT_RX; e->session_index = s->session_index; } } s->rx_bytes_pending += n_read; return n_read; } void vppcom_session_free_segments (uint32_t session_handle, uint32_t n_bytes) { vcl_worker_t *wrk = vcl_worker_get_current (); vcl_session_t *s; u8 is_ct; s = vcl_session_get_w_handle (wrk, session_handle); if (PREDICT_FALSE (!s || (s->flags & VCL_SESSION_F_IS_VEP))) return; is_ct = vcl_session_is_ct (s); svm_fifo_dequeue_drop (is_ct ? s->ct_rx_fifo : s->rx_fifo, n_bytes); ASSERT (s->rx_bytes_pending >= n_bytes); s->rx_bytes_pending -= n_bytes; } always_inline u8 vcl_fifo_is_writeable (svm_fifo_t * f, u32 len, u8 is_dgram) { u32 max_enq = svm_fifo_max_enqueue_prod (f); if (is_dgram) return max_enq >= (sizeof (session_dgram_hdr_t) + len); else return max_enq > 0; } always_inline int vppcom_session_write_inline (vcl_worker_t * wrk, vcl_session_t * s, void *buf, size_t n, u8 is_flush, u8 is_dgram) { int n_write, is_nonblocking; session_evt_type_t et; svm_fifo_t *tx_fifo; svm_msg_q_t *mq; u8 is_ct; /* Accept zero length writes but just return */ if (PREDICT_FALSE (!n)) return VPPCOM_OK; if (PREDICT_FALSE (!buf)) return VPPCOM_EFAULT; if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP)) { VDBG (0, "ERROR: session %u [0x%llx]: cannot write to an epoll" " session!", s->session_index, s->vpp_handle); return VPPCOM_EBADFD; } if (PREDICT_FALSE (!vcl_session_is_open (s))) { VDBG (1, "session %u [0x%llx]: is not open! state 0x%x (%s)", s->session_index, s->vpp_handle, s->session_state, vcl_session_state_str (s->session_state)); return vcl_session_closed_error (s);; } if (PREDICT_FALSE (s->flags & VCL_SESSION_F_WR_SHUTDOWN)) { VDBG (1, "session %u [0x%llx]: is shutdown! state 0x%x (%s)", s->session_index, s->vpp_handle, s->session_state, vcl_session_state_str (s->session_state)); return VPPCOM_EPIPE; } is_ct = vcl_session_is_ct (s); tx_fifo = is_ct ? s->ct_tx_fifo : s->tx_fifo; is_nonblocking = vcl_session_has_attr (s, VCL_SESS_ATTR_NONBLOCK); mq = wrk->app_event_queue; if (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram)) { if (is_nonblocking) { return VPPCOM_EWOULDBLOCK; } while (!vcl_fifo_is_writeable (tx_fifo, n, is_dgram)) { svm_fifo_add_want_deq_ntf (tx_fifo, SVM_FIFO_WANT_DEQ_NOTIF); if (vcl_session_is_closing (s)) return vcl_session_closing_error (s); svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY); vcl_worker_flush_mq_events (wrk); } } et = SESSION_IO_EVT_TX; if (is_flush && !is_ct) et = SESSION_IO_EVT_TX_FLUSH; if (is_dgram) n_write = app_send_dgram_raw (tx_fifo, &s->transport, s->vpp_evt_q, buf, n, et, 0 /* do_evt */ , SVM_Q_WAIT); else n_write = app_send_stream_raw (tx_fifo, s->vpp_evt_q, buf, n, et, 0 /* do_evt */ , SVM_Q_WAIT); if (svm_fifo_set_event (s->tx_fifo)) app_send_io_evt_to_vpp ( s->vpp_evt_q, s->tx_fifo->shr->master_session_index, et, SVM_Q_WAIT); /* The underlying fifo segment can run out of memory */ if (PREDICT_FALSE (n_write < 0)) return VPPCOM_EAGAIN; VDBG (2, "session %u [0x%llx]: wrote %d bytes", s->session_index, s->vpp_handle, n_write); return n_write; } int vppcom_session_write (uint32_t session_handle, void *buf, size_t n) { vcl_worker_t *wrk = vcl_worker_get_current (); vcl_session_t *s; s = vcl_session_get_w_handle (wrk, session_handle); if (PREDICT_FALSE (!s)) return VPPCOM_EBADFD; return vppcom_session_write_inline (wrk, s, buf, n, 0 /* is_flush */ , s->is_dgram ? 1 : 0); } int vppcom_session_write_msg (uint32_t session_handle, void *buf, size_t n) { vcl_worker_t *wrk = vcl_worker_get_current (); vcl_session_t *s; s = vcl_session_get_w_handle (wrk, session_handle); if (PREDICT_FALSE (!s)) return VPPCOM_EBADFD; return vppcom_session_write_inline (wrk, s, buf, n, 1 /* is_flush */ , s->is_dgram ? 1 : 0); } #define vcl_fifo_rx_evt_valid_or_break(_s) \ if (PREDICT_FALSE (!_s->rx_fifo)) \ break; \ if (PREDICT_FALSE (svm_fifo_is_empty (_s->rx_fifo))) \ { \ if (!vcl_session_is_ct (_s)) \ { \ svm_fifo_unset_event (_s->rx_fifo); \ if (svm_fifo_is_empty (_s->rx_fifo)) \ break; \ } \ else if (svm_fifo_is_empty (_s->ct_rx_fifo)) \ { \ svm_fifo_unset_event (_s->rx_fifo); /* rx evts on actual fifo*/ \ if (svm_fifo_is_empty (_s->ct_rx_fifo)) \ break; \ } \ } \ static void vcl_select_handle_mq_event (vcl_worker_t * wrk, session_event_t * e, unsigned long n_bits, unsigned long *read_map, unsigned long *write_map, unsigned long *except_map, u32 * bits_set) { session_disconnected_msg_t *disconnected_msg; session_connected_msg_t *connected_msg; vcl_session_t *s; u32 sid; switch (e->event_type) { case SESSION_IO_EVT_RX: sid = e->session_index; s = vcl_session_get (wrk, sid); if (!s || !vcl_session_is_open (s)) break; vcl_fifo_rx_evt_valid_or_break (s); if (sid < n_bits && read_map) { clib_bitmap_set_no_check ((uword *) read_map, sid, 1); *bits_set += 1; } break; case SESSION_IO_EVT_TX: sid = e->session_index; s = vcl_session_get (wrk, sid); if (!s || !vcl_session_is_open (s)) break; if (sid < n_bits && write_map) { clib_bitmap_set_no_check ((uword *) write_map, sid, 1); *bits_set += 1; } break; case SESSION_CTRL_EVT_ACCEPTED: if (!e->postponed) s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data); else s = vcl_session_get (wrk, e->session_index); if (!s) break; sid = s->session_index; if (sid < n_bits && read_map) { clib_bitmap_set_no_check ((uword *) read_map, sid, 1); *bits_set += 1; } break; case SESSION_CTRL_EVT_CONNECTED: if (!e->postponed) { connected_msg = (session_connected_msg_t *) e->data; sid = vcl_session_connected_handler (wrk, connected_msg); } else sid = e->session_index; if (sid == VCL_INVALID_SESSION_INDEX) break; if (sid < n_bits && write_map) { clib_bitmap_set_no_check ((uword *) write_map, sid, 1); *bits_set += 1; } break; case SESSION_CTRL_EVT_DISCONNECTED: disconnected_msg = (session_disconnected_msg_t *) e->data; s = vcl_session_disconnected_handler (wrk, disconnected_msg); if (!s) break; sid = s->session_index; if (sid < n_bits && except_map) { clib_bitmap_set_no_check ((uword *) except_map, sid, 1); *bits_set += 1; } break; case SESSION_CTRL_EVT_RESET: sid = vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data); if (sid < n_bits && except_map) { clib_bitmap_set_no_check ((uword *) except_map, sid, 1); *bits_set += 1; } break; case SESSION_CTRL_EVT_UNLISTEN_REPLY: vcl_session_unlisten_reply_handler (wrk, e->data); break; case SESSION_CTRL_EVT_MIGRATED: vcl_session_migrated_handler (wrk, e->data); break; case SESSION_CTRL_EVT_CLEANUP: vcl_session_cleanup_handler (wrk, e->data); break; case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY: vcl_session_worker_update_reply_handler (wrk, e->data); break; case SESSION_CTRL_EVT_REQ_WORKER_UPDATE: vcl_session_req_worker_update_handler (wrk, e->data); break; case SESSION_CTRL_EVT_APP_ADD_SEGMENT: vcl_session_app_add_segment_handler (wrk, e->data); break; case SESSION_CTRL_EVT_APP_DEL_SEGMENT: vcl_session_app_del_segment_handler (wrk, e->data); break; case SESSION_CTRL_EVT_APP_WRK_RPC: vcl_worker_rpc_handler (wrk, e->data); break; default: clib_warning ("unhandled: %u", e->event_type); break; } } static int vcl_select_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq, unsigned long n_bits, unsigned long *read_map, unsigned long *write_map, unsigned long *except_map, double time_to_wait, u32 * bits_set) { svm_msg_q_msg_t *msg; session_event_t *e; u32 i; if (svm_msg_q_is_empty (mq)) { if (*bits_set) return 0; if (!time_to_wait) return 0; else if (time_to_wait < 0) svm_msg_q_wait (mq, SVM_MQ_WAIT_EMPTY); else { if (svm_msg_q_timedwait (mq, time_to_wait)) return 0; } } vcl_mq_dequeue_batch (wrk, mq, ~0); for (i = 0; i < vec_len (wrk->mq_msg_vector); i++) { msg = vec_elt_at_index (wrk->mq_msg_vector, i); e = svm_msg_q_msg_data (mq, msg); vcl_select_handle_mq_event (wrk, e, n_bits, read_map, write_map, except_map, bits_set); svm_msg_q_free_msg (mq, msg); } vec_reset_length (wrk->mq_msg_vector); vcl_handle_pending_wrk_updates (wrk); return *bits_set; } static int vppcom_select_condvar (vcl_worker_t * wrk, int n_bits, vcl_si_set * read_map, vcl_si_set * write_map, vcl_si_set * except_map, double time_to_wait, u32 * bits_set) { double wait = 0, start = 0; if (!*bits_set) { wait = time_to_wait; start = clib_time_now (&wrk->clib_time); } do { vcl_select_handle_mq (wrk, wrk->app_event_queue, n_bits, read_map, write_map, except_map, wait, bits_set); if (*bits_set) return *bits_set; if (wait == -1) continue; wait = wait - (clib_time_now (&wrk->clib_time) - start); } while (wait > 0); return 0; } static int vppcom_select_eventfd (vcl_worker_t * wrk, int n_bits, vcl_si_set * read_map, vcl_si_set * write_map, vcl_si_set * except_map, double time_to_wait, u32 * bits_set) { vcl_mq_evt_conn_t *mqc; int __clib_unused n_read; int n_mq_evts, i; u64 buf; if (PREDICT_FALSE (wrk->api_client_handle == ~0)) { vcl_api_retry_attach (wrk); return 0; } vec_validate (wrk->mq_events, pool_elts (wrk->mq_evt_conns)); n_mq_evts = epoll_wait (wrk->mqs_epfd, wrk->mq_events, vec_len (wrk->mq_events), time_to_wait); for (i = 0; i < n_mq_evts; i++) { if (PREDICT_FALSE (wrk->mq_events[i].data.u32 == ~0)) { vcl_api_handle_disconnect (wrk); continue; } mqc = vcl_mq_evt_conn_get (wrk, wrk->mq_events[i].data.u32); n_read = read (mqc->mq_fd, &buf, sizeof (buf)); vcl_select_handle_mq (wrk, mqc->mq, n_bits, read_map, write_map, except_map, 0, bits_set); } return (n_mq_evts > 0 ? (int) *bits_set : 0); } int vppcom_select (int n_bits, vcl_si_set * read_map, vcl_si_set * write_map, vcl_si_set * except_map, double time_to_wait) { u32 sid, minbits = clib_max (n_bits, BITS (uword)), bits_set = 0; vcl_worker_t *wrk = vcl_worker_get_current (); vcl_session_t *s = 0; int i; if (n_bits && read_map) { clib_bitmap_validate (wrk->rd_bitmap, minbits); clib_memcpy_fast (wrk->rd_bitmap, read_map, vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set)); memset (read_map, 0, vec_len (wrk->rd_bitmap) * sizeof (vcl_si_set)); } if (n_bits && write_map) { clib_bitmap_validate (wrk->wr_bitmap, minbits); clib_memcpy_fast (wrk->wr_bitmap, write_map, vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set)); memset (write_map, 0, vec_len (wrk->wr_bitmap) * sizeof (vcl_si_set)); } if (n_bits && except_map) { clib_bitmap_validate (wrk->ex_bitmap, minbits); clib_memcpy_fast (wrk->ex_bitmap, except_map, vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set)); memset (except_map, 0, vec_len (wrk->ex_bitmap) * sizeof (vcl_si_set)); } if (!n_bits) return 0; if (!write_map) goto check_rd; clib_bitmap_foreach (sid, wrk->wr_bitmap) { if (!(s = vcl_session_get (wrk, sid))) { clib_bitmap_set_no_check ((uword *) write_map, sid, 1); bits_set++; continue; } if (vcl_session_write_ready (s)) { clib_bitmap_set_no_check ((uword *) write_map, sid, 1); bits_set++; } else { svm_fifo_t *txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo; svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF); } } check_rd: if (!read_map) goto check_mq; clib_bitmap_foreach (sid, wrk->rd_bitmap) { if (!(s = vcl_session_get (wrk, sid))) { clib_bitmap_set_no_check ((uword *) read_map, sid, 1); bits_set++; continue; } if (vcl_session_read_ready (s)) { clib_bitmap_set_no_check ((uword *) read_map, sid, 1); bits_set++; } } check_mq: for (i = 0; i < vec_len (wrk->unhandled_evts_vector); i++) { vcl_select_handle_mq_event (wrk, &wrk->unhandled_evts_vector[i], n_bits, read_map, write_map, except_map, &bits_set); } vec_reset_length (wrk->unhandled_evts_vector); if (vcm->cfg.use_mq_eventfd) vppcom_select_eventfd (wrk, n_bits, read_map, write_map, except_map, time_to_wait, &bits_set); else vppcom_select_condvar (wrk, n_bits, read_map, write_map, except_map, time_to_wait, &bits_set); return (bits_set); } static inline void vep_verify_epoll_chain (vcl_worker_t * wrk, u32 vep_handle) { vppcom_epoll_t *vep; u32 sh = vep_handle; vcl_session_t *s; if (VPPCOM_DEBUG <= 2) return; s = vcl_session_get_w_handle (wrk, vep_handle); if (PREDICT_FALSE (!s)) { VDBG (0, "ERROR: Invalid vep_sh (%u)!", vep_handle); goto done; } if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP))) { VDBG (0, "ERROR: vep_sh (%u) is not a vep!", vep_handle); goto done; } vep = &s->vep; VDBG (0, "vep_sh (%u): Dumping epoll chain\n" "{\n" " is_vep = %u\n" " is_vep_session = %u\n" " next_sh = 0x%x (%u)\n" "}\n", vep_handle, s->flags & VCL_SESSION_F_IS_VEP, s->flags & VCL_SESSION_F_IS_VEP_SESSION, vep->next_sh, vep->next_sh); for (sh = vep->next_sh; sh != ~0; sh = vep->next_sh) { s = vcl_session_get_w_handle (wrk, sh); if (PREDICT_FALSE (!s)) { VDBG (0, "ERROR: Invalid sh (%u)!", sh); goto done; } if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP)) { VDBG (0, "ERROR: sh (%u) is a vep!", vep_handle); } else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION))) { VDBG (0, "ERROR: sh (%u) is not a vep session handle!", sh); goto done; } vep = &s->vep; if (PREDICT_FALSE (vep->vep_sh != vep_handle)) VDBG (0, "ERROR: session (%u) vep_sh (%u) != vep_sh (%u)!", sh, s->vep.vep_sh, vep_handle); if (s->flags & VCL_SESSION_F_IS_VEP_SESSION) { VDBG (0, "vep_sh[%u]: sh 0x%x (%u)\n" "{\n" " next_sh = 0x%x (%u)\n" " prev_sh = 0x%x (%u)\n" " vep_sh = 0x%x (%u)\n" " ev.events = 0x%x\n" " ev.data.u64 = 0x%llx\n" " et_mask = 0x%x\n" "}\n", vep_handle, sh, sh, vep->next_sh, vep->next_sh, vep->prev_sh, vep->prev_sh, vep->vep_sh, vep->vep_sh, vep->ev.events, vep->ev.data.u64, vep->et_mask); } } done: VDBG (0, "vep_sh (%u): Dump complete!\n", vep_handle); } int vppcom_epoll_create (void) { vcl_worker_t *wrk = vcl_worker_get_current (); vcl_session_t *vep_session; vep_session = vcl_session_alloc (wrk); vep_session->flags |= VCL_SESSION_F_IS_VEP; vep_session->vep.vep_sh = ~0; vep_session->vep.next_sh = ~0; vep_session->vep.prev_sh = ~0; vep_session->vpp_handle = ~0; vcl_evt (VCL_EVT_EPOLL_CREATE, vep_session, vep_session->session_index); VDBG (0, "Created vep_idx %u", vep_session->session_index); return vcl_session_handle (vep_session); } int vppcom_epoll_ctl (uint32_t vep_handle, int op, uint32_t session_handle, struct epoll_event *event) { vcl_worker_t *wrk = vcl_worker_get_current (); int rv = VPPCOM_OK, add_evt = 0; vcl_session_t *vep_session; vcl_session_t *s; svm_fifo_t *txf; if (vep_handle == session_handle) { VDBG (0, "vep_sh == session handle (%u)!", vep_handle); return VPPCOM_EINVAL; } vep_session = vcl_session_get_w_handle (wrk, vep_handle); if (PREDICT_FALSE (!vep_session)) { VDBG (0, "Invalid vep_sh (%u)!", vep_handle); return VPPCOM_EBADFD; } if (PREDICT_FALSE (!(vep_session->flags & VCL_SESSION_F_IS_VEP))) { VDBG (0, "vep_sh (%u) is not a vep!", vep_handle); return VPPCOM_EINVAL; } ASSERT (vep_session->vep.vep_sh == ~0); ASSERT (vep_session->vep.prev_sh == ~0); s = vcl_session_get_w_handle (wrk, session_handle); if (PREDICT_FALSE (!s)) { VDBG (0, "Invalid session_handle (%u)!", session_handle); return VPPCOM_EBADFD; } if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP)) { VDBG (0, "session_handle (%u) is a vep!", vep_handle); return VPPCOM_EINVAL; } switch (op) { case EPOLL_CTL_ADD: if (PREDICT_FALSE (!event)) { VDBG (0, "EPOLL_CTL_ADD: NULL pointer to epoll_event structure!"); return VPPCOM_EINVAL; } if (s->flags & VCL_SESSION_F_IS_VEP_SESSION) { VDBG (0, "EPOLL_CTL_ADD: %u already epolled!", s->session_index); rv = VPPCOM_EEXIST; goto done; } if (vep_session->vep.next_sh != ~0) { vcl_session_t *next_session; next_session = vcl_session_get_w_handle (wrk, vep_session->vep.next_sh); if (PREDICT_FALSE (!next_session)) { VDBG (0, "EPOLL_CTL_ADD: Invalid vep.next_sh (%u) on " "vep_idx (%u)!", vep_session->vep.next_sh, vep_handle); return VPPCOM_EBADFD; } ASSERT (next_session->vep.prev_sh == vep_handle); next_session->vep.prev_sh = session_handle; } s->vep.next_sh = vep_session->vep.next_sh; s->vep.prev_sh = vep_handle; s->vep.vep_sh = vep_handle; s->vep.et_mask = VEP_DEFAULT_ET_MASK; s->vep.lt_next = VCL_INVALID_SESSION_INDEX; s->vep.ev = *event; s->flags &= ~VCL_SESSION_F_IS_VEP; s->flags |= VCL_SESSION_F_IS_VEP_SESSION; vep_session->vep.next_sh = session_handle; txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo; if (txf && (event->events & EPOLLOUT)) svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL); /* Generate EPOLLOUT if tx fifo not full */ if ((event->events & EPOLLOUT) && (vcl_session_write_ready (s) > 0)) { session_event_t e = { 0 }; e.event_type = SESSION_IO_EVT_TX; e.session_index = s->session_index; vec_add1 (wrk->unhandled_evts_vector, e); add_evt = 1; } /* Generate EPOLLIN if rx fifo has data */ if ((event->events & EPOLLIN) && (vcl_session_read_ready (s) > 0)) { session_event_t e = { 0 }; e.event_type = SESSION_IO_EVT_RX; e.session_index = s->session_index; vec_add1 (wrk->unhandled_evts_vector, e); s->flags &= ~VCL_SESSION_F_HAS_RX_EVT; add_evt = 1; } if (!add_evt && vcl_session_is_closing (s)) { session_event_t e = { 0 }; if (s->session_state == VCL_STATE_VPP_CLOSING) e.event_type = SESSION_CTRL_EVT_DISCONNECTED; else e.event_type = SESSION_CTRL_EVT_RESET; e.session_index = s->session_index; e.postponed = 1; vec_add1 (wrk->unhandled_evts_vector, e); } VDBG (1, "EPOLL_CTL_ADD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!", vep_handle, session_handle, event->events, event->data.u64); vcl_evt (VCL_EVT_EPOLL_CTLADD, s, event->events, event->data.u64); break; case EPOLL_CTL_MOD: if (PREDICT_FALSE (!event)) { VDBG (0, "EPOLL_CTL_MOD: NULL pointer to epoll_event structure!"); rv = VPPCOM_EINVAL; goto done; } else if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION))) { VDBG (0, "sh %u EPOLL_CTL_MOD: not a vep session!", session_handle); rv = VPPCOM_ENOENT; goto done; } else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle)) { VDBG (0, "EPOLL_CTL_MOD: sh %u vep_sh (%u) != vep_sh (%u)!", session_handle, s->vep.vep_sh, vep_handle); rv = VPPCOM_EINVAL; goto done; } /* Generate EPOLLOUT if session write ready nd event was not on */ if ((event->events & EPOLLOUT) && !(s->vep.ev.events & EPOLLOUT) && (vcl_session_write_ready (s) > 0)) { session_event_t e = { 0 }; e.event_type = SESSION_IO_EVT_TX; e.session_index = s->session_index; vec_add1 (wrk->unhandled_evts_vector, e); } /* Generate EPOLLIN if session read ready and event was not on */ if ((event->events & EPOLLIN) && !(s->vep.ev.events & EPOLLIN) && (vcl_session_read_ready (s) > 0)) { session_event_t e = { 0 }; e.event_type = SESSION_IO_EVT_RX; e.session_index = s->session_index; vec_add1 (wrk->unhandled_evts_vector, e); s->flags &= ~VCL_SESSION_F_HAS_RX_EVT; } s->vep.et_mask = VEP_DEFAULT_ET_MASK; s->vep.ev = *event; txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo; if (txf) { if (event->events & EPOLLOUT) svm_fifo_add_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL); else svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL); } VDBG (1, "EPOLL_CTL_MOD: vep_sh %u, sh %u, events 0x%x, data 0x%llx!", vep_handle, session_handle, event->events, event->data.u64); break; case EPOLL_CTL_DEL: if (PREDICT_FALSE (!(s->flags & VCL_SESSION_F_IS_VEP_SESSION))) { VDBG (0, "EPOLL_CTL_DEL: %u not a vep session!", session_handle); rv = VPPCOM_ENOENT; goto done; } else if (PREDICT_FALSE (s->vep.vep_sh != vep_handle)) { VDBG (0, "EPOLL_CTL_DEL: sh %u vep_sh (%u) != vep_sh (%u)!", session_handle, s->vep.vep_sh, vep_handle); rv = VPPCOM_EINVAL; goto done; } if (s->vep.prev_sh == vep_handle) vep_session->vep.next_sh = s->vep.next_sh; else { vcl_session_t *prev_session; prev_session = vcl_session_get_w_handle (wrk, s->vep.prev_sh); if (PREDICT_FALSE (!prev_session)) { VDBG (0, "EPOLL_CTL_DEL: Invalid prev_sh (%u) on sh (%u)!", s->vep.prev_sh, session_handle); return VPPCOM_EBADFD; } ASSERT (prev_session->vep.next_sh == session_handle); prev_session->vep.next_sh = s->vep.next_sh; } if (s->vep.next_sh != ~0) { vcl_session_t *next_session; next_session = vcl_session_get_w_handle (wrk, s->vep.next_sh); if (PREDICT_FALSE (!next_session)) { VDBG (0, "EPOLL_CTL_DEL: Invalid next_sh (%u) on sh (%u)!", s->vep.next_sh, session_handle); return VPPCOM_EBADFD; } ASSERT (next_session->vep.prev_sh == session_handle); next_session->vep.prev_sh = s->vep.prev_sh; } if (s->vep.lt_next != VCL_INVALID_SESSION_INDEX) vcl_epoll_lt_del (wrk, s); memset (&s->vep, 0, sizeof (s->vep)); s->vep.next_sh = ~0; s->vep.prev_sh = ~0; s->vep.vep_sh = ~0; s->vep.lt_next = VCL_INVALID_SESSION_INDEX; s->flags &= ~VCL_SESSION_F_IS_VEP_SESSION; if (vcl_session_is_open (s)) { txf = vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo; if (txf) svm_fifo_del_want_deq_ntf (txf, SVM_FIFO_WANT_DEQ_NOTIF_IF_FULL); } VDBG (1, "EPOLL_CTL_DEL: vep_idx %u, sh %u!", vep_handle, session_handle); vcl_evt (VCL_EVT_EPOLL_CTLDEL, s, vep_sh); break; default: VDBG (0, "Invalid operation (%d)!", op); rv = VPPCOM_EINVAL; } vep_verify_epoll_chain (wrk, vep_handle); done: return rv; } static inline void vcl_epoll_wait_handle_mq_event (vcl_worker_t * wrk, session_event_t * e, struct epoll_event *events, u32 * num_ev) { session_disconnected_msg_t *disconnected_msg; session_connected_msg_t *connected_msg; u32 sid = ~0, session_events; u64 session_evt_data = ~0; vcl_session_t *s; u8 add_event = 0; switch (e->event_type) { case SESSION_IO_EVT_RX: sid = e->session_index; s = vcl_session_get (wrk, sid); if (vcl_session_is_closed (s)) break; vcl_fifo_rx_evt_valid_or_break (s); session_events = s->vep.ev.events; if (!(EPOLLIN & s->vep.ev.events) || (s->flags & VCL_SESSION_F_HAS_RX_EVT) || (s->vep.lt_next != VCL_INVALID_SESSION_INDEX)) break; add_event = 1; events[*num_ev].events = EPOLLIN; session_evt_data = s->vep.ev.data.u64; s->flags |= VCL_SESSION_F_HAS_RX_EVT; break; case SESSION_IO_EVT_TX: sid = e->session_index; s = vcl_session_get (wrk, sid); if (!s || !vcl_session_is_open (s)) break; session_events = s->vep.ev.events; if (!(EPOLLOUT & session_events)) break; add_event = 1; events[*num_ev].events = EPOLLOUT; session_evt_data = s->vep.ev.data.u64; svm_fifo_reset_has_deq_ntf (vcl_session_is_ct (s) ? s->ct_tx_fifo : s->tx_fifo); break; case SESSION_CTRL_EVT_ACCEPTED: if (!e->postponed) s = vcl_session_accepted (wrk, (session_accepted_msg_t *) e->data); else s = vcl_session_get (wrk, e->session_index); if (!s) break; session_events = s->vep.ev.events; sid = s->session_index; if (!(EPOLLIN & session_events) || (s->vep.lt_next != VCL_INVALID_SESSION_INDEX)) break; add_event = 1; events[*num_ev].events = EPOLLIN; session_evt_data = s->vep.ev.data.u64; break; case SESSION_CTRL_EVT_CONNECTED: if (!e->postponed) { connected_msg = (session_connected_msg_t *) e->data; sid = vcl_session_connected_handler (wrk, connected_msg); } else sid = e->session_index; s = vcl_session_get (wrk, sid); if (vcl_session_is_closed (s)) break; session_events = s->vep.ev.events; /* Generate EPOLLOUT because there's no connected event */ if (!(EPOLLOUT & session_events)) break; add_event = 1; events[*num_ev].events = EPOLLOUT; session_evt_data = s->vep.ev.data.u64; if (s->session_state == VCL_STATE_DETACHED) events[*num_ev].events |= EPOLLHUP; break; case SESSION_CTRL_EVT_DISCONNECTED: if (!e->postponed) { disconnected_msg = (session_disconnected_msg_t *) e->data; s = vcl_session_disconnected_handler (wrk, disconnected_msg); } else { s = vcl_session_get (wrk, e->session_index); s->flags &= ~VCL_SESSION_F_PENDING_DISCONNECT; } if (vcl_session_is_closed (s) || !(s->flags & VCL_SESSION_F_IS_VEP_SESSION)) { if (s && (s->flags & VCL_SESSION_F_PENDING_FREE)) vcl_session_free (wrk, s); break; } sid = s->session_index; session_events = s->vep.ev.events; add_event = 1; if (EPOLLRDHUP & session_events) { /* If app can distinguish between RDHUP and HUP, * we make finer control */ events[*num_ev].events = EPOLLRDHUP; if (s->flags & VCL_SESSION_F_WR_SHUTDOWN) { events[*num_ev].events |= EPOLLHUP; } } else { events[*num_ev].events = EPOLLHUP; } session_evt_data = s->vep.ev.data.u64; break; case SESSION_CTRL_EVT_RESET: if (!e->postponed) { sid = vcl_session_reset_handler (wrk, (session_reset_msg_t *) e->data); s = vcl_session_get (wrk, sid); } else { sid = e->session_index; s = vcl_session_get (wrk, sid); s->flags &= ~VCL_SESSION_F_PENDING_DISCONNECT; } if (vcl_session_is_closed (s) || !(s->flags & VCL_SESSION_F_IS_VEP_SESSION)) { if (s && (s->flags & VCL_SESSION_F_PENDING_FREE)) vcl_session_free (wrk, s); break; } session_events = s->vep.ev.events; add_event = 1; events[*num_ev].events = EPOLLERR | EPOLLHUP; if ((EPOLLRDHUP & session_events) && (s->flags & VCL_SESSION_F_RD_SHUTDOWN)) { events[*num_ev].events |= EPOLLRDHUP; } if ((EPOLLIN & session_events) && (s->flags & VCL_SESSION_F_RD_SHUTDOWN)) { events[*num_ev].events |= EPOLLIN; } session_evt_data = s->vep.ev.data.u64; break; case SESSION_CTRL_EVT_UNLISTEN_REPLY: vcl_session_unlisten_reply_handler (wrk, e->data); break; case SESSION_CTRL_EVT_MIGRATED: vcl_session_migrated_handler (wrk, e->data); break; case SESSION_CTRL_EVT_CLEANUP: vcl_session_cleanup_handler (wrk, e->data); break; case SESSION_CTRL_EVT_REQ_WORKER_UPDATE: vcl_session_req_worker_update_handler (wrk, e->data); break; case SESSION_CTRL_EVT_WORKER_UPDATE_REPLY: vcl_session_worker_update_reply_handler (wrk, e->data); break; case SESSION_CTRL_EVT_APP_ADD_SEGMENT: vcl_session_app_add_segment_handler (wrk, e->data); break; case SESSION_CTRL_EVT_APP_DEL_SEGMENT: vcl_session_app_del_segment_handler (wrk, e->data); break; case SESSION_CTRL_EVT_APP_WRK_RPC: vcl_worker_rpc_handler (wrk, e->data); break; default: VDBG (0, "unhandled: %u", e->event_type); break; } if (add_event) { events[*num_ev].data.u64 = session_evt_data; if (EPOLLONESHOT & session_events) { s = vcl_session_get (wrk, sid); s->vep.ev.events = 0; } else if (!(EPOLLET & session_events)) { s = vcl_session_get (wrk, sid); if (s->vep.lt_next == VCL_INVALID_SESSION_INDEX) vcl_epoll_lt_add (wrk, s); } *num_ev += 1; } } static int vcl_epoll_wait_handle_mq (vcl_worker_t * wrk, svm_msg_q_t * mq, struct epoll_event *events, u
# Doxyfile 1.8.11

# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
#
# All text after a double hash (##) is considered a comment and is placed in
# front of the TAG it is preceding.
#
# All text after a single hash (#) is considered a comment and will be ignored.
# The format is:
# TAG = value [value, ...]
# For lists, items can also be appended using:
# TAG += value [value, ...]
# Values that contain spaces should be placed between quotes (\" \").

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------

# This tag specifies the encoding used for all characters in the config file
# that follow. The default is UTF-8 which is also the encoding used for all text
# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
# for the list of possible encodings.
# The default value is: UTF-8.

DOXYFILE_ENCODING      = UTF-8

# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
# double-quotes, unless you are using Doxywizard) that should identify the
# project for which the documentation is generated. This name is used in the
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME           = "FD.io VPP"

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER         = $(VERSION)

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.

PROJECT_BRIEF          = "Vector Packet Processing"

# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.

PROJECT_LOGO           = $(ROOT)/doxygen/assets/logo_fdio.png

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.

OUTPUT_DIRECTORY       = $(BUILD_ROOT)/docs

# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
# will distribute the generated files over these directories. Enabling this
# option can be useful when feeding doxygen a huge amount of source files, where
# putting all generated files in the same directory would otherwise causes
# performance problems for the file system.
# The default value is: NO.

CREATE_SUBDIRS         = YES

# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
# characters to appear in the names of generated files. If set to NO, non-ASCII
# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
# U+3044.
# The default value is: NO.

ALLOW_UNICODE_NAMES    = NO

# The OUTPUT_LANGUAGE tag is used to specify the language in which all
# documentation generated by doxygen is written. Doxygen will use this
# information to generate all constant output in the proper language.
# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese.
# The default value is: English.

OUTPUT_LANGUAGE        = English

# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
# descriptions after the members that are listed in the file and class
# documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.

BRIEF_MEMBER_DESC      = YES

# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
# description of a member or function before the detailed description
#
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
# The default value is: YES.

REPEAT_BRIEF           = YES

# This tag implements a quasi-intelligent brief description abbreviator that is
# used to form the text in various listings. Each string in this list, if found
# as the leading text of the brief description, will be stripped from the text
# and the result, after processing the whole list, is used as the annotated
# text. Otherwise, the brief description is used as-is. If left blank, the
# following values are used ($name is automatically replaced with the name of
# the entity):The $name class, The $name widget, The $name file, is, provides,
# specifies, contains, represents, a, an and the.

ABBREVIATE_BRIEF       =

# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# doxygen will generate a detailed section even if there is only a brief
# description.
# The default value is: NO.

ALWAYS_DETAILED_SEC    = NO

# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
# The default value is: NO.

INLINE_INHERITED_MEMB  = NO

# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
# before files name in the file list and in the header files. If set to NO the
# shortest path that makes the file name unique will be used
# The default value is: YES.

FULL_PATH_NAMES        = YES

# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
# part of the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the path to
# strip.
#
# Note that you can specify absolute paths here, but also relative paths, which
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.

STRIP_FROM_PATH        = $(ROOT)

# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
# header file to include in order to use a class. If left blank only the name of
# the header file containing the class definition is used. Otherwise one should
# specify the list of include paths that are normally passed to the compiler
# using the -I flag.

STRIP_FROM_INC_PATH    = $(ROOT)

# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't
# support long names like on DOS, Mac, or CD-ROM.
# The default value is: NO.

SHORT_NAMES            = NO

# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
# first line (until the first dot) of a Javadoc-style comment as the brief
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
# style comments (thus requiring an explicit @brief command for a brief
# description.)
# The default value is: NO.

JAVADOC_AUTOBRIEF      = YES

# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
# requiring an explicit \brief command for a brief description.)
# The default value is: NO.

QT_AUTOBRIEF           = NO

# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
# a brief description. This used to be the default behavior. The new default is
# to treat a multi-line C++ comment block as a detailed description. Set this
# tag to YES if you prefer the old behavior instead.
#
# Note that setting this tag to YES also means that rational rose comments are
# not recognized any more.
# The default value is: NO.

MULTILINE_CPP_IS_BRIEF = NO

# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.

INHERIT_DOCS           = YES

# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
# page for each member. If set to NO, the documentation of a member will be part
# of the file/class/namespace that contains it.
# The default value is: NO.

SEPARATE_MEMBER_PAGES  = NO

# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
# uses this value to replace tabs by spaces in code fragments.
# Minimum value: 1, maximum value: 16, default value: 4.

TAB_SIZE               = 8

# This tag can be used to specify a number of aliases that act as commands in
# the documentation. An alias has the form:
# name=value
# For example adding
# "sideeffect=@par Side Effects:\n"
# will allow you to put the command \sideeffect (or @sideeffect) in the
# documentation, which will result in a user-defined paragraph with heading
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.

ALIASES                =

## Indexes VPP graph nodes
ALIASES += "node=@xrefitem nodes \"Node Identifier\" \"Node Identifiers\" @c "

## Formatting for CLI commands and output
ALIASES += "cli{1}=<code><pre>\1</code></pre>"
ALIASES += "clistart=<code><pre>"
ALIASES += "cliend=</pre></code>"

## Formatting for CLI example paragraphs
ALIASES += "cliexpar=@par Example usage"
ALIASES += "cliexcmd{1}=@clistart<b>vpp# <em>\1</em></b>@cliend"
ALIASES += "cliexstart{1}=@cliexcmd{\1}@clistart"
ALIASES += "cliexend=@cliend"

## Formatting for config directives
ALIASES += "cfgcmd{2}=@par <code><pre>\1 \2</pre></code>"
ALIASES += "cfgcmd{1}=@par <code><pre>\1</pre></code>"

# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
# will allow you to use the command class in the itcl::class meaning.

TCL_SUBST              =

# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
# instance, some of the names that are used will be different. The list of all
# members will be omitted, etc.
# The default value is: NO.

OPTIMIZE_OUTPUT_FOR_C  = YES

# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
# for that language. For instance, namespaces will be presented as packages,
# qualified scopes will look different, etc.
# The default value is: NO.

OPTIMIZE_OUTPUT_JAVA   = NO

# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources. Doxygen will then generate output that is tailored for Fortran.
# The default value is: NO.

OPTIMIZE_FOR_FORTRAN   = NO

# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for VHDL.
# The default value is: NO.

OPTIMIZE_OUTPUT_VHDL   = NO

# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, and
# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
# Fortran. In the later case the parser tries to guess whether the code is fixed
# or free formatted code, this is the default for Fortran type files), VHDL. For
# instance to make doxygen treat .inc files as Fortran files (default is PHP),
# and .f files as C (default is Fortran), use: inc=Fortran f=C.
#
# Note: For files without extension you can use no_extension as a placeholder.
#
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen.

EXTENSION_MAPPING      = def=C api=C

# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
# documentation. See http://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
# The default value is: YES.

MARKDOWN_SUPPORT       = YES

# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
# be prevented in individual cases by putting a % sign in front of the word or
# globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.

AUTOLINK_SUPPORT       = YES

# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should set this
# tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string);
# versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
# The default value is: NO.

BUILTIN_STL_SUPPORT    = NO

# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
# The defaul