2 *------------------------------------------------------------------
3 * Copyright (c) 2016 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
21 #include <sys/types.h>
23 #include <sys/ioctl.h>
24 #include <sys/socket.h>
28 #include <sys/prctl.h>
29 #include <sys/eventfd.h>
33 #include <vlib/vlib.h>
34 #include <vlib/unix/unix.h>
35 #include <vnet/plugin/plugin.h>
36 #include <vnet/ethernet/ethernet.h>
37 #include <vpp/app/version.h>
39 #include <memif/memif.h>
40 #include <memif/private.h>
43 memif_socket_close (clib_socket_t ** s)
45 memif_file_del_by_index ((*s)->private_data);
51 memif_str2vec (uint8_t * str, int len)
59 for (i = 0; i < len; i++)
71 memif_msg_enq_ack (memif_if_t * mif)
73 memif_msg_fifo_elt_t *e;
74 clib_fifo_add2 (mif->msg_queue, e);
76 e->msg.type = MEMIF_MSG_TYPE_ACK;
81 memif_msg_enq_hello (clib_socket_t * sock)
84 memif_msg_t msg = { 0 };
85 memif_msg_hello_t *h = &msg.hello;
86 msg.type = MEMIF_MSG_TYPE_HELLO;
87 h->min_version = MEMIF_VERSION;
88 h->max_version = MEMIF_VERSION;
89 h->max_m2s_ring = MEMIF_MAX_M2S_RING;
90 h->max_s2m_ring = MEMIF_MAX_S2M_RING;
91 h->max_region = MEMIF_MAX_REGION;
92 h->max_log2_ring_size = MEMIF_MAX_LOG2_RING_SIZE;
93 s = format (0, "VPP %s%c", VPP_BUILD_VER, 0);
94 strncpy ((char *) h->name, (char *) s, sizeof (h->name) - 1);
96 return clib_socket_sendmsg (sock, &msg, sizeof (memif_msg_t), 0, 0);
100 memif_msg_enq_init (memif_if_t * mif)
103 memif_msg_fifo_elt_t *e;
104 clib_fifo_add2 (mif->msg_queue, e);
105 memif_msg_init_t *i = &e->msg.init;
107 e->msg.type = MEMIF_MSG_TYPE_INIT;
109 i->version = MEMIF_VERSION;
112 s = format (0, "VPP %s%c", VPP_BUILD_VER, 0);
113 strncpy ((char *) i->name, (char *) s, sizeof (i->name) - 1);
115 strncpy ((char *) i->secret, (char *) mif->secret,
116 sizeof (i->secret) - 1);
121 memif_msg_enq_add_region (memif_if_t * mif, u8 region)
123 memif_msg_fifo_elt_t *e;
124 clib_fifo_add2 (mif->msg_queue, e);
125 memif_msg_add_region_t *ar = &e->msg.add_region;
127 e->msg.type = MEMIF_MSG_TYPE_ADD_REGION;
128 e->fd = mif->regions[region].fd;
130 ar->size = mif->regions[region].region_size;
134 memif_msg_enq_add_ring (memif_if_t * mif, u8 index, u8 direction)
136 memif_msg_fifo_elt_t *e;
137 clib_fifo_add2 (mif->msg_queue, e);
138 memif_msg_add_ring_t *ar = &e->msg.add_ring;
141 ASSERT ((mif->flags & MEMIF_IF_FLAG_IS_SLAVE) != 0);
143 e->msg.type = MEMIF_MSG_TYPE_ADD_RING;
145 if (direction == MEMIF_RING_M2S)
146 mq = vec_elt_at_index (mif->rx_queues, index);
148 mq = vec_elt_at_index (mif->tx_queues, index);
152 ar->region = mq->region;
153 ar->offset = mq->offset;
154 ar->log2_ring_size = mq->log2_ring_size;
155 ar->flags = (direction == MEMIF_RING_S2M) ? MEMIF_MSG_ADD_RING_FLAG_S2M : 0;
156 ar->private_hdr_size = 0;
160 memif_msg_enq_connect (memif_if_t * mif)
162 memif_msg_fifo_elt_t *e;
163 clib_fifo_add2 (mif->msg_queue, e);
164 memif_msg_connect_t *c = &e->msg.connect;
167 e->msg.type = MEMIF_MSG_TYPE_CONNECT;
169 s = format (0, "%U%c", format_memif_device_name, mif->dev_instance, 0);
170 strncpy ((char *) c->if_name, (char *) s, sizeof (c->if_name) - 1);
175 memif_msg_enq_connected (memif_if_t * mif)
177 memif_msg_fifo_elt_t *e;
178 clib_fifo_add2 (mif->msg_queue, e);
179 memif_msg_connected_t *c = &e->msg.connected;
182 e->msg.type = MEMIF_MSG_TYPE_CONNECTED;
184 s = format (0, "%U%c", format_memif_device_name, mif->dev_instance, 0);
185 strncpy ((char *) c->if_name, (char *) s, sizeof (c->if_name) - 1);
190 memif_msg_send_disconnect (memif_if_t * mif, clib_error_t * err)
192 memif_msg_t msg = { 0 };
193 msg.type = MEMIF_MSG_TYPE_DISCONNECT;
194 memif_msg_disconnect_t *d = &msg.disconnect;
197 strncpy ((char *) d->string, (char *) err->what, sizeof (d->string) - 1);
199 return clib_socket_sendmsg (mif->sock, &msg, sizeof (memif_msg_t), 0, 0);
202 static clib_error_t *
203 memif_msg_receive_hello (memif_if_t * mif, memif_msg_t * msg)
205 memif_msg_hello_t *h = &msg->hello;
207 if (msg->hello.min_version > MEMIF_VERSION ||
208 msg->hello.max_version < MEMIF_VERSION)
209 return clib_error_return (0, "incompatible protocol version");
211 mif->run.num_s2m_rings = clib_min (h->max_s2m_ring + 1,
212 mif->cfg.num_s2m_rings);
213 mif->run.num_m2s_rings = clib_min (h->max_m2s_ring + 1,
214 mif->cfg.num_m2s_rings);
215 mif->run.log2_ring_size = clib_min (h->max_log2_ring_size,
216 mif->cfg.log2_ring_size);
217 mif->run.buffer_size = mif->cfg.buffer_size;
219 mif->remote_name = memif_str2vec (h->name, sizeof (h->name));
224 static clib_error_t *
225 memif_msg_receive_init (memif_if_t ** mifp, memif_msg_t * msg,
226 clib_socket_t * sock, uword socket_file_index)
228 memif_main_t *mm = &memif_main;
229 memif_socket_file_t *msf =
230 vec_elt_at_index (mm->socket_files, socket_file_index);
231 memif_msg_init_t *i = &msg->init;
232 memif_if_t *mif, tmp;
236 if (i->version != MEMIF_VERSION)
238 memif_file_del_by_index (sock->private_data);
239 return clib_error_return (0, "unsupported version");
242 p = mhash_get (&msf->dev_instance_by_id, &i->id);
246 err = clib_error_return (0, "unmatched interface id");
250 mif = vec_elt_at_index (mm->interfaces, p[0]);
252 if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
254 err = clib_error_return (0, "cannot connect to slave");
260 err = clib_error_return (0, "already connected");
264 if (i->mode != mif->mode)
266 err = clib_error_return (0, "mode mismatch");
271 hash_set (msf->dev_instance_by_fd, mif->sock->fd, mif->dev_instance);
272 mif->remote_name = memif_str2vec (i->name, sizeof (i->name));
279 s = memif_str2vec (i->secret, sizeof (i->secret));
281 return clib_error_return (0, "secret required");
283 r = vec_cmp (s, mif->secret);
287 return clib_error_return (0, "incorrect secret");
294 memif_msg_send_disconnect (&tmp, err);
295 memif_socket_close (&sock);
299 static clib_error_t *
300 memif_msg_receive_add_region (memif_if_t * mif, memif_msg_t * msg, int fd)
302 memif_msg_add_region_t *ar = &msg->add_region;
305 return clib_error_return (0, "missing memory region fd");
307 if (ar->index != vec_len (mif->regions))
308 return clib_error_return (0, "unexpected region index");
310 if (ar->index > MEMIF_MAX_REGION)
311 return clib_error_return (0, "too many regions");
313 vec_validate_aligned (mif->regions, ar->index, CLIB_CACHE_LINE_BYTES);
314 mr = vec_elt_at_index (mif->regions, ar->index);
316 mr->region_size = ar->size;
321 static clib_error_t *
322 memif_msg_receive_add_ring (memif_if_t * mif, memif_msg_t * msg, int fd)
324 memif_msg_add_ring_t *ar = &msg->add_ring;
328 return clib_error_return (0, "missing ring interrupt fd");
330 if (ar->private_hdr_size != 0)
331 return clib_error_return (0, "private headers not supported");
333 if (ar->flags & MEMIF_MSG_ADD_RING_FLAG_S2M)
335 if (ar->index != vec_len (mif->rx_queues))
336 return clib_error_return (0, "unexpected ring index");
338 if (ar->index > MEMIF_MAX_S2M_RING)
339 return clib_error_return (0, "too many rings");
341 vec_validate_aligned (mif->rx_queues, ar->index, CLIB_CACHE_LINE_BYTES);
342 mq = vec_elt_at_index (mif->rx_queues, ar->index);
343 mif->run.num_s2m_rings = vec_len (mif->rx_queues);
347 if (ar->index != vec_len (mif->tx_queues))
348 return clib_error_return (0, "unexpected ring index");
350 if (ar->index > MEMIF_MAX_M2S_RING)
351 return clib_error_return (0, "too many rings");
353 vec_validate_aligned (mif->tx_queues, ar->index, CLIB_CACHE_LINE_BYTES);
354 mq = vec_elt_at_index (mif->tx_queues, ar->index);
355 mif->run.num_m2s_rings = vec_len (mif->tx_queues);
358 // clear previous cache data if interface reconncected
359 memset (mq, 0, sizeof (memif_queue_t));
361 mq->int_clib_file_index = ~0;
362 mq->log2_ring_size = ar->log2_ring_size;
363 mq->region = ar->region;
364 mq->offset = ar->offset;
366 (ar->flags & MEMIF_MSG_ADD_RING_FLAG_S2M) ? MEMIF_RING_S2M :
372 static clib_error_t *
373 memif_msg_receive_connect (memif_if_t * mif, memif_msg_t * msg)
376 memif_msg_connect_t *c = &msg->connect;
378 if ((err = memif_connect (mif)))
381 mif->remote_if_name = memif_str2vec (c->if_name, sizeof (c->if_name));
386 static clib_error_t *
387 memif_msg_receive_connected (memif_if_t * mif, memif_msg_t * msg)
390 memif_msg_connected_t *c = &msg->connected;
392 if ((err = memif_connect (mif)))
395 mif->remote_if_name = memif_str2vec (c->if_name, sizeof (c->if_name));
399 static clib_error_t *
400 memif_msg_receive_disconnect (memif_if_t * mif, memif_msg_t * msg)
402 memif_msg_disconnect_t *d = &msg->disconnect;
404 mif->remote_disc_string = memif_str2vec (d->string, sizeof (d->string));
405 return clib_error_return (0, "disconnect received");
408 static clib_error_t *
409 memif_msg_receive (memif_if_t ** mifp, clib_socket_t * sock, clib_file_t * uf)
411 memif_main_t *mm = &memif_main;
412 memif_msg_t msg = { 0 };
413 clib_error_t *err = 0;
416 memif_if_t *mif = *mifp;
418 err = clib_socket_recvmsg (sock, &msg, sizeof (memif_msg_t), &fd, 1);
422 if (mif == 0 && msg.type != MEMIF_MSG_TYPE_INIT)
424 memif_socket_close (&sock);
425 err = clib_error_return (0, "unexpected message received");
429 vlib_log_debug (mm->log_class, "Message type %u received", msg.type);
430 /* process the message based on its type */
433 case MEMIF_MSG_TYPE_ACK:
436 case MEMIF_MSG_TYPE_HELLO:
437 if ((err = memif_msg_receive_hello (mif, &msg)))
439 if ((err = memif_init_regions_and_queues (mif)))
441 memif_msg_enq_init (mif);
443 vec_foreach_index (i, mif->regions)
444 memif_msg_enq_add_region (mif, i);
445 vec_foreach_index (i, mif->tx_queues)
446 memif_msg_enq_add_ring (mif, i, MEMIF_RING_S2M);
447 vec_foreach_index (i, mif->rx_queues)
448 memif_msg_enq_add_ring (mif, i, MEMIF_RING_M2S);
450 memif_msg_enq_connect (mif);
453 case MEMIF_MSG_TYPE_INIT:
454 if ((err = memif_msg_receive_init (mifp, &msg, sock, uf->private_data)))
457 vec_reset_length (uf->description);
458 uf->description = format (uf->description, "%U ctl",
459 format_memif_device_name, mif->dev_instance);
460 memif_msg_enq_ack (mif);
463 case MEMIF_MSG_TYPE_ADD_REGION:
464 if ((err = memif_msg_receive_add_region (mif, &msg, fd)))
466 memif_msg_enq_ack (mif);
469 case MEMIF_MSG_TYPE_ADD_RING:
470 if ((err = memif_msg_receive_add_ring (mif, &msg, fd)))
472 memif_msg_enq_ack (mif);
475 case MEMIF_MSG_TYPE_CONNECT:
476 if ((err = memif_msg_receive_connect (mif, &msg)))
478 memif_msg_enq_connected (mif);
481 case MEMIF_MSG_TYPE_CONNECTED:
482 if ((err = memif_msg_receive_connected (mif, &msg)))
486 case MEMIF_MSG_TYPE_DISCONNECT:
487 if ((err = memif_msg_receive_disconnect (mif, &msg)))
492 err = clib_error_return (0, "unknown message type (0x%x)", msg.type);
496 if (clib_fifo_elts (mif->msg_queue))
497 clib_file_set_data_available_to_write (&file_main,
498 mif->sock->private_data, 1);
502 vlib_log_err (mm->log_class, "%U", format_clib_error, err);
507 memif_master_conn_fd_read_ready (clib_file_t * uf)
509 memif_main_t *mm = &memif_main;
510 memif_socket_file_t *msf =
511 pool_elt_at_index (mm->socket_files, uf->private_data);
514 clib_socket_t *sock = 0;
515 clib_error_t *err = 0;
517 p = hash_get (msf->dev_instance_by_fd, uf->file_descriptor);
520 mif = vec_elt_at_index (mm->interfaces, p[0]);
525 /* This is new connection, remove index from pending vector */
527 vec_foreach_index (i, msf->pending_clients)
528 if (msf->pending_clients[i]->fd == uf->file_descriptor)
530 sock = msf->pending_clients[i];
531 vec_del1 (msf->pending_clients, i);
536 err = memif_msg_receive (&mif, sock, uf);
539 memif_disconnect (mif, err);
540 clib_error_free (err);
546 memif_slave_conn_fd_read_ready (clib_file_t * uf)
548 memif_main_t *mm = &memif_main;
550 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data);
551 err = memif_msg_receive (&mif, mif->sock, uf);
554 memif_disconnect (mif, err);
555 clib_error_free (err);
560 static clib_error_t *
561 memif_conn_fd_write_ready (clib_file_t * uf, memif_if_t * mif)
563 memif_msg_fifo_elt_t *e;
564 clib_fifo_sub2 (mif->msg_queue, e);
565 clib_file_set_data_available_to_write (&file_main,
566 mif->sock->private_data, 0);
567 return clib_socket_sendmsg (mif->sock, &e->msg, sizeof (memif_msg_t),
568 &e->fd, e->fd > -1 ? 1 : 0);
572 memif_master_conn_fd_write_ready (clib_file_t * uf)
574 memif_main_t *mm = &memif_main;
575 memif_socket_file_t *msf =
576 pool_elt_at_index (mm->socket_files, uf->private_data);
580 p = hash_get (msf->dev_instance_by_fd, uf->file_descriptor);
584 mif = vec_elt_at_index (mm->interfaces, p[0]);
585 return memif_conn_fd_write_ready (uf, mif);
589 memif_slave_conn_fd_write_ready (clib_file_t * uf)
591 memif_main_t *mm = &memif_main;
592 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data);
593 return memif_conn_fd_write_ready (uf, mif);
597 memif_slave_conn_fd_error (clib_file_t * uf)
599 memif_main_t *mm = &memif_main;
600 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data);
603 err = clib_error_return (0, "connection fd error");
604 memif_disconnect (mif, err);
605 clib_error_free (err);
611 memif_master_conn_fd_error (clib_file_t * uf)
613 memif_main_t *mm = &memif_main;
614 memif_socket_file_t *msf =
615 pool_elt_at_index (mm->socket_files, uf->private_data);
619 p = hash_get (msf->dev_instance_by_fd, uf->file_descriptor);
624 mif = vec_elt_at_index (mm->interfaces, p[0]);
625 err = clib_error_return (0, "connection fd error");
626 memif_disconnect (mif, err);
627 clib_error_free (err);
632 vec_foreach_index (i, msf->pending_clients)
633 if (msf->pending_clients[i]->fd == uf->file_descriptor)
635 clib_socket_t *s = msf->pending_clients[i];
636 memif_socket_close (&s);
637 vec_del1 (msf->pending_clients, i);
642 vlib_log_warn (mm->log_class, "Error on unknown file descriptor %d",
643 uf->file_descriptor);
650 memif_conn_fd_accept_ready (clib_file_t * uf)
652 memif_main_t *mm = &memif_main;
653 memif_socket_file_t *msf =
654 pool_elt_at_index (mm->socket_files, uf->private_data);
655 clib_file_t template = { 0 };
657 clib_socket_t *client;
659 client = clib_mem_alloc (sizeof (clib_socket_t));
660 memset (client, 0, sizeof (clib_socket_t));
661 err = clib_socket_accept (msf->sock, client);
665 template.read_function = memif_master_conn_fd_read_ready;
666 template.write_function = memif_master_conn_fd_write_ready;
667 template.error_function = memif_master_conn_fd_error;
668 template.file_descriptor = client->fd;
669 template.private_data = uf->private_data;
670 template.description = format (0, "memif in conn on %s", msf->filename);
672 memif_file_add (&client->private_data, &template);
674 err = memif_msg_enq_hello (client);
677 clib_socket_close (client);
681 vec_add1 (msf->pending_clients, client);
686 vlib_log_err (mm->log_class, "%U", format_clib_error, err);
687 clib_mem_free (client);
692 * fd.io coding-style-patch-verification: ON
695 * eval: (c-set-style "gnu")