2 * Copyright (c) 2018-2019 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <vcl/vcl_private.h>
18 static pthread_key_t vcl_worker_stop_key;
21 vcl_mq_evt_conn_alloc (vcl_worker_t * wrk)
23 vcl_mq_evt_conn_t *mqc;
24 pool_get (wrk->mq_evt_conns, mqc);
25 memset (mqc, 0, sizeof (*mqc));
30 vcl_mq_evt_conn_index (vcl_worker_t * wrk, vcl_mq_evt_conn_t * mqc)
32 return (mqc - wrk->mq_evt_conns);
36 vcl_mq_evt_conn_get (vcl_worker_t * wrk, u32 mq_conn_idx)
38 return pool_elt_at_index (wrk->mq_evt_conns, mq_conn_idx);
41 /* Add unix socket to epoll.
42 * Used only to get a notification on socket close
43 * We can't use eventfd because we don't get notifications on that fds
46 vcl_mq_epoll_add_api_sock (vcl_worker_t *wrk)
48 clib_socket_t *cs = &wrk->app_api_sock;
49 struct epoll_event e = { 0 };
53 rv = epoll_ctl (wrk->mqs_epfd, EPOLL_CTL_ADD, cs->fd, &e);
54 if (rv != EEXIST && rv < 0)
61 vcl_mq_epoll_add_evfd (vcl_worker_t * wrk, svm_msg_q_t * mq)
63 struct epoll_event e = { 0 };
64 vcl_mq_evt_conn_t *mqc;
68 mq_fd = svm_msg_q_get_eventfd (mq);
70 if (wrk->mqs_epfd < 0 || mq_fd == -1)
73 mqc = vcl_mq_evt_conn_alloc (wrk);
74 mqc_index = vcl_mq_evt_conn_index (wrk, mqc);
79 e.data.u32 = mqc_index;
80 if (epoll_ctl (wrk->mqs_epfd, EPOLL_CTL_ADD, mq_fd, &e) < 0)
82 VDBG (0, "failed to add mq eventfd to mq epoll fd");
86 if (vcl_mq_epoll_add_api_sock (wrk))
88 VDBG (0, "failed to add mq socket to mq epoll fd");
96 vcl_mq_epoll_del_evfd (vcl_worker_t * wrk, u32 mqc_index)
98 vcl_mq_evt_conn_t *mqc;
100 if (wrk->mqs_epfd || mqc_index == ~0)
103 mqc = vcl_mq_evt_conn_get (wrk, mqc_index);
104 if (epoll_ctl (wrk->mqs_epfd, EPOLL_CTL_DEL, mqc->mq_fd, 0) < 0)
106 VDBG (0, "failed to del mq eventfd to mq epoll fd");
112 static vcl_worker_t *
113 vcl_worker_alloc (void)
116 pool_get (vcm->workers, wrk);
117 memset (wrk, 0, sizeof (*wrk));
118 wrk->wrk_index = wrk - vcm->workers;
119 wrk->forked_child = ~0;
124 vcl_worker_free (vcl_worker_t * wrk)
126 pool_put (vcm->workers, wrk);
130 vcl_api_app_worker_add (void)
132 if (vcm->cfg.vpp_app_socket_api)
133 return vcl_sapi_app_worker_add ();
135 return vcl_bapi_app_worker_add ();
139 vcl_api_app_worker_del (vcl_worker_t * wrk)
141 if (vcm->cfg.vpp_app_socket_api)
142 return vcl_sapi_app_worker_del (wrk);
144 vcl_bapi_app_worker_del (wrk);
148 vcl_worker_cleanup (vcl_worker_t * wrk, u8 notify_vpp)
150 clib_spinlock_lock (&vcm->workers_lock);
152 vcl_api_app_worker_del (wrk);
154 if (wrk->mqs_epfd > 0)
155 close (wrk->mqs_epfd);
156 pool_free (wrk->sessions);
157 pool_free (wrk->mq_evt_conns);
158 hash_free (wrk->session_index_by_vpp_handles);
159 vec_free (wrk->mq_events);
160 vec_free (wrk->mq_msg_vector);
161 vec_free (wrk->unhandled_evts_vector);
162 vec_free (wrk->pending_session_wrk_updates);
163 clib_bitmap_free (wrk->rd_bitmap);
164 clib_bitmap_free (wrk->wr_bitmap);
165 clib_bitmap_free (wrk->ex_bitmap);
166 vcl_worker_free (wrk);
167 clib_spinlock_unlock (&vcm->workers_lock);
171 vcl_worker_cleanup_cb (void *arg)
176 wrk_index = vcl_get_worker_index ();
177 wrk = vcl_worker_get_if_valid (wrk_index);
181 vcl_worker_cleanup (wrk, 1 /* notify vpp */ );
182 vcl_set_worker_index (~0);
183 VDBG (0, "cleaned up worker %u", wrk_index);
187 vcl_worker_detach_sessions (vcl_worker_t *wrk)
191 uword *seg_indices_map = 0;
192 u32 seg_index, val, *seg_indices = 0;
194 close (wrk->app_api_sock.fd);
195 pool_foreach (s, wrk->sessions)
197 if (s->session_state == VCL_STATE_LISTEN)
199 s->session_state = VCL_STATE_LISTEN_NO_MQ;
202 if ((s->flags & VCL_SESSION_F_IS_VEP) ||
203 s->session_state == VCL_STATE_LISTEN_NO_MQ ||
204 s->session_state == VCL_STATE_CLOSED)
207 hash_set (seg_indices_map, s->tx_fifo->segment_index, 1);
209 s->session_state = VCL_STATE_DETACHED;
210 vec_add2 (wrk->unhandled_evts_vector, e, 1);
211 e->event_type = SESSION_CTRL_EVT_DISCONNECTED;
212 e->session_index = s->session_index;
216 hash_foreach (seg_index, val, seg_indices_map,
217 ({ vec_add1 (seg_indices, seg_index); }));
219 vcl_segment_detach_segments (seg_indices);
221 /* Detach worker's mqs segment */
222 vcl_segment_detach (vcl_vpp_worker_segment_handle (wrk->wrk_index));
224 vec_free (seg_indices);
225 hash_free (seg_indices_map);
229 vcl_worker_alloc_and_init ()
233 /* This was initialized already */
234 if (vcl_get_worker_index () != ~0)
237 /* Grab lock before selecting mem thread index */
238 clib_spinlock_lock (&vcm->workers_lock);
240 /* Use separate heap map entry for worker */
241 clib_mem_set_thread_index ();
243 if (pool_elts (vcm->workers) == vcm->cfg.max_workers)
245 VDBG (0, "max-workers %u limit reached", vcm->cfg.max_workers);
250 wrk = vcl_worker_alloc ();
251 vcl_set_worker_index (wrk->wrk_index);
252 wrk->thread_id = pthread_self ();
253 wrk->current_pid = getpid ();
256 if (vcm->cfg.use_mq_eventfd)
258 wrk->vcl_needs_real_epoll = 1;
259 wrk->mqs_epfd = epoll_create (1);
260 wrk->vcl_needs_real_epoll = 0;
261 if (wrk->mqs_epfd < 0)
263 clib_unix_warning ("epoll_create() returned");
268 wrk->ep_lt_current = VCL_INVALID_SESSION_INDEX;
269 wrk->session_index_by_vpp_handles = hash_create (0, sizeof (uword));
270 clib_time_init (&wrk->clib_time);
271 vec_validate (wrk->mq_events, 64);
272 vec_validate (wrk->mq_msg_vector, 128);
273 vec_reset_length (wrk->mq_msg_vector);
274 vec_validate (wrk->unhandled_evts_vector, 128);
275 vec_reset_length (wrk->unhandled_evts_vector);
278 clib_spinlock_unlock (&vcm->workers_lock);
283 vcl_worker_register_with_vpp (void)
285 vcl_worker_t *wrk = vcl_worker_get_current ();
287 clib_spinlock_lock (&vcm->workers_lock);
289 if (vcl_api_app_worker_add ())
291 VDBG (0, "failed to add worker to vpp");
292 clib_spinlock_unlock (&vcm->workers_lock);
295 if (pthread_key_create (&vcl_worker_stop_key, vcl_worker_cleanup_cb))
296 VDBG (0, "failed to add pthread cleanup function");
297 if (pthread_setspecific (vcl_worker_stop_key, &wrk->thread_id))
298 VDBG (0, "failed to setup key value");
300 clib_spinlock_unlock (&vcm->workers_lock);
302 VDBG (0, "added worker %u", wrk->wrk_index);
307 vcl_worker_ctrl_mq (vcl_worker_t * wrk)
313 vcl_session_read_ready (vcl_session_t * s)
315 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
317 VDBG (0, "ERROR: session %u: cannot read from an epoll session!",
319 return VPPCOM_EBADFD;
322 if (vcl_session_is_open (s))
324 if (vcl_session_is_ct (s))
325 return svm_fifo_max_dequeue_cons (s->ct_rx_fifo);
329 session_dgram_pre_hdr_t ph;
332 max_deq = svm_fifo_max_dequeue_cons (s->rx_fifo);
333 if (max_deq <= SESSION_CONN_HDR_LEN)
335 if (svm_fifo_peek (s->rx_fifo, 0, sizeof (ph), (u8 *) & ph) < 0)
337 if (ph.data_length + SESSION_CONN_HDR_LEN > max_deq)
340 return ph.data_length;
343 return svm_fifo_max_dequeue_cons (s->rx_fifo);
345 else if (s->session_state == VCL_STATE_LISTEN)
347 return clib_fifo_elts (s->accept_evts_fifo);
351 return (s->session_state == VCL_STATE_DISCONNECT) ?
352 VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
357 vcl_session_write_ready (vcl_session_t * s)
359 if (PREDICT_FALSE (s->flags & VCL_SESSION_F_IS_VEP))
361 VDBG (0, "session %u [0x%llx]: cannot write to an epoll session!",
362 s->session_index, s->vpp_handle);
363 return VPPCOM_EBADFD;
366 if (vcl_session_is_open (s))
368 if (vcl_session_is_ct (s))
369 return svm_fifo_max_enqueue_prod (s->ct_tx_fifo);
373 u32 max_enq = svm_fifo_max_enqueue_prod (s->tx_fifo);
375 if (max_enq <= sizeof (session_dgram_hdr_t))
377 return max_enq - sizeof (session_dgram_hdr_t);
380 return svm_fifo_max_enqueue_prod (s->tx_fifo);
382 else if (s->session_state == VCL_STATE_LISTEN)
385 return svm_fifo_max_enqueue_prod (s->tx_fifo);
387 return VPPCOM_EBADFD;
389 else if (s->session_state == VCL_STATE_UPDATED)
395 return (s->session_state == VCL_STATE_DISCONNECT) ?
396 VPPCOM_ECONNRESET : VPPCOM_ENOTCONN;
401 vcl_session_alloc_ext_cfg (vcl_session_t *s,
402 transport_endpt_ext_cfg_type_t type, u32 len)
407 s->ext_config = clib_mem_alloc (len);
408 clib_memset (s->ext_config, 0, len);
409 s->ext_config->len = len;
410 s->ext_config->type = type;
416 vcl_segment_attach (u64 segment_handle, char *name, ssvm_segment_type_t type,
419 fifo_segment_create_args_t _a, *a = &_a;
422 memset (a, 0, sizeof (*a));
423 a->segment_name = name;
424 a->segment_type = type;
426 if (type == SSVM_SEGMENT_MEMFD)
429 clib_rwlock_writer_lock (&vcm->segment_table_lock);
431 if ((rv = fifo_segment_attach (&vcm->segment_main, a)))
433 clib_warning ("svm_fifo_segment_attach ('%s') failed", name);
436 hash_set (vcm->segment_table, segment_handle, a->new_segment_indices[0]);
438 clib_rwlock_writer_unlock (&vcm->segment_table_lock);
440 vec_free (a->new_segment_indices);
445 vcl_segment_table_lookup (u64 segment_handle)
449 clib_rwlock_reader_lock (&vcm->segment_table_lock);
450 seg_indexp = hash_get (vcm->segment_table, segment_handle);
451 clib_rwlock_reader_unlock (&vcm->segment_table_lock);
454 return VCL_INVALID_SEGMENT_INDEX;
455 return ((u32) * seg_indexp);
459 vcl_segment_detach (u64 segment_handle)
461 fifo_segment_main_t *sm = &vcm->segment_main;
462 fifo_segment_t *segment;
465 segment_index = vcl_segment_table_lookup (segment_handle);
466 if (segment_index == (u32) ~ 0)
469 clib_rwlock_writer_lock (&vcm->segment_table_lock);
471 segment = fifo_segment_get_segment (sm, segment_index);
472 fifo_segment_delete (sm, segment);
473 hash_unset (vcm->segment_table, segment_handle);
475 clib_rwlock_writer_unlock (&vcm->segment_table_lock);
477 VDBG (0, "detached segment %u handle %u", segment_index, segment_handle);
481 vcl_segment_detach_segments (u32 *seg_indices)
483 u64 *seg_handles = 0, *seg_handle, key;
487 clib_rwlock_reader_lock (&vcm->segment_table_lock);
489 vec_foreach (seg_index, seg_indices)
491 /* clang-format off */
492 hash_foreach (key, val, vcm->segment_table, ({
493 if (val == *seg_index)
495 vec_add1 (seg_handles, key);
499 /* clang-format on */
502 clib_rwlock_reader_unlock (&vcm->segment_table_lock);
504 vec_foreach (seg_handle, seg_handles)
505 vcl_segment_detach (seg_handle[0]);
507 vec_free (seg_handles);
511 vcl_segment_attach_session (uword segment_handle, uword rxf_offset,
512 uword txf_offset, uword mq_offset, u32 mq_index,
513 u8 is_ct, vcl_session_t *s)
515 u32 fs_index, eqs_index;
516 svm_fifo_t *rxf, *txf;
520 fs_index = vcl_segment_table_lookup (segment_handle);
521 if (fs_index == VCL_INVALID_SEGMENT_INDEX)
523 VDBG (0, "ERROR: segment for session %u is not mounted!",
528 if (!is_ct && mq_offset != (uword) ~0)
530 eqs_handle = vcl_vpp_worker_segment_handle (0);
531 eqs_index = vcl_segment_table_lookup (eqs_handle);
532 ASSERT (eqs_index != VCL_INVALID_SEGMENT_INDEX);
535 clib_rwlock_reader_lock (&vcm->segment_table_lock);
537 fs = fifo_segment_get_segment (&vcm->segment_main, fs_index);
538 rxf = fifo_segment_alloc_fifo_w_offset (fs, rxf_offset);
539 txf = fifo_segment_alloc_fifo_w_offset (fs, txf_offset);
540 rxf->segment_index = fs_index;
541 txf->segment_index = fs_index;
543 if (!is_ct && mq_offset != (uword) ~0)
545 fs = fifo_segment_get_segment (&vcm->segment_main, eqs_index);
546 s->vpp_evt_q = fifo_segment_msg_q_attach (fs, mq_offset, mq_index);
549 clib_rwlock_reader_unlock (&vcm->segment_table_lock);
553 rxf->shr->client_session_index = s->session_index;
554 txf->shr->client_session_index = s->session_index;
555 rxf->client_thread_index = vcl_get_worker_index ();
556 txf->client_thread_index = vcl_get_worker_index ();
570 vcl_session_detach_fifos (vcl_session_t *s)
577 clib_rwlock_reader_lock (&vcm->segment_table_lock);
579 fs = fifo_segment_get_segment_if_valid (&vcm->segment_main,
580 s->rx_fifo->segment_index);
584 fifo_segment_free_client_fifo (fs, s->rx_fifo);
585 fifo_segment_free_client_fifo (fs, s->tx_fifo);
588 fs = fifo_segment_get_segment_if_valid (&vcm->segment_main,
589 s->ct_rx_fifo->segment_index);
593 fifo_segment_free_client_fifo (fs, s->ct_rx_fifo);
594 fifo_segment_free_client_fifo (fs, s->ct_tx_fifo);
598 clib_rwlock_reader_unlock (&vcm->segment_table_lock);
602 vcl_segment_attach_mq (uword segment_handle, uword mq_offset, u32 mq_index,
608 fs_index = vcl_segment_table_lookup (segment_handle);
609 if (fs_index == VCL_INVALID_SEGMENT_INDEX)
611 VDBG (0, "ERROR: mq segment %lx for is not attached!", segment_handle);
615 clib_rwlock_reader_lock (&vcm->segment_table_lock);
617 fs = fifo_segment_get_segment (&vcm->segment_main, fs_index);
618 *mq = fifo_segment_msg_q_attach (fs, mq_offset, mq_index);
620 clib_rwlock_reader_unlock (&vcm->segment_table_lock);
626 vcl_segment_discover_mqs (uword segment_handle, int *fds, u32 n_fds)
631 fs_index = vcl_segment_table_lookup (segment_handle);
632 if (fs_index == VCL_INVALID_SEGMENT_INDEX)
634 VDBG (0, "ERROR: mq segment %lx for is not attached!", segment_handle);
638 clib_rwlock_reader_lock (&vcm->segment_table_lock);
640 fs = fifo_segment_get_segment (&vcm->segment_main, fs_index);
641 fifo_segment_msg_qs_discover (fs, fds, n_fds);
643 clib_rwlock_reader_unlock (&vcm->segment_table_lock);
649 vcl_segment_alloc_chunk (uword segment_handle, u32 slice_index, u32 size,
656 fs_index = vcl_segment_table_lookup (segment_handle);
657 if (fs_index == VCL_INVALID_SEGMENT_INDEX)
659 VDBG (0, "ERROR: mq segment %lx for is not attached!", segment_handle);
663 clib_rwlock_reader_lock (&vcm->segment_table_lock);
665 fs = fifo_segment_get_segment (&vcm->segment_main, fs_index);
666 c = fifo_segment_alloc_chunk_w_slice (fs, slice_index, size);
667 *offset = fifo_segment_chunk_offset (fs, c);
669 clib_rwlock_reader_unlock (&vcm->segment_table_lock);
675 vcl_session_share_fifos (vcl_session_t *s, svm_fifo_t *rxf, svm_fifo_t *txf)
677 vcl_worker_t *wrk = vcl_worker_get_current ();
680 clib_rwlock_reader_lock (&vcm->segment_table_lock);
682 fs = fifo_segment_get_segment (&vcm->segment_main, rxf->segment_index);
683 s->rx_fifo = fifo_segment_duplicate_fifo (fs, rxf);
684 s->tx_fifo = fifo_segment_duplicate_fifo (fs, txf);
686 clib_rwlock_reader_unlock (&vcm->segment_table_lock);
688 svm_fifo_add_subscriber (s->rx_fifo, wrk->vpp_wrk_index);
689 svm_fifo_add_subscriber (s->tx_fifo, wrk->vpp_wrk_index);
695 vcl_session_state_str (vcl_session_state_t state)
701 case VCL_STATE_CLOSED:
704 case VCL_STATE_LISTEN:
707 case VCL_STATE_READY:
710 case VCL_STATE_VPP_CLOSING:
711 st = "STATE_VPP_CLOSING";
713 case VCL_STATE_DISCONNECT:
714 st = "STATE_DISCONNECT";
716 case VCL_STATE_DETACHED:
717 st = "STATE_DETACHED";
719 case VCL_STATE_UPDATED:
720 st = "STATE_UPDATED";
722 case VCL_STATE_LISTEN_NO_MQ:
723 st = "STATE_LISTEN_NO_MQ";
726 st = "UNKNOWN_STATE";
734 vcl_format_ip4_address (u8 *s, va_list *args)
736 u8 *a = va_arg (*args, u8 *);
737 return format (s, "%d.%d.%d.%d", a[0], a[1], a[2], a[3]);
741 vcl_format_ip6_address (u8 *s, va_list *args)
743 ip6_address_t *a = va_arg (*args, ip6_address_t *);
744 u32 i, i_max_n_zero, max_n_zeros, i_first_zero, n_zeros, last_double_colon;
746 i_max_n_zero = ARRAY_LEN (a->as_u16);
748 i_first_zero = i_max_n_zero;
750 for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
752 u32 is_zero = a->as_u16[i] == 0;
753 if (is_zero && i_first_zero >= ARRAY_LEN (a->as_u16))
759 if ((!is_zero && n_zeros > max_n_zeros) ||
760 (i + 1 >= ARRAY_LEN (a->as_u16) && n_zeros > max_n_zeros))
762 i_max_n_zero = i_first_zero;
763 max_n_zeros = n_zeros;
764 i_first_zero = ARRAY_LEN (a->as_u16);
769 last_double_colon = 0;
770 for (i = 0; i < ARRAY_LEN (a->as_u16); i++)
772 if (i == i_max_n_zero && max_n_zeros > 1)
774 s = format (s, "::");
775 i += max_n_zeros - 1;
776 last_double_colon = 1;
780 s = format (s, "%s%x", (last_double_colon || i == 0) ? "" : ":",
781 clib_net_to_host_u16 (a->as_u16[i]));
782 last_double_colon = 0;
789 /* Format an IP46 address. */
791 vcl_format_ip46_address (u8 *s, va_list *args)
793 ip46_address_t *ip46 = va_arg (*args, ip46_address_t *);
794 ip46_type_t type = va_arg (*args, ip46_type_t);
800 is_ip4 = ip46_address_is_ip4 (ip46);
810 return is_ip4 ? format (s, "%U", vcl_format_ip4_address, &ip46->ip4) :
811 format (s, "%U", vcl_format_ip6_address, &ip46->ip6);
815 * fd.io coding-style-patch-verification: ON
818 * eval: (c-set-style "gnu")