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_M2S_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;
159 memif_msg_enq_connect (memif_if_t * mif)
161 memif_msg_fifo_elt_t *e;
162 clib_fifo_add2 (mif->msg_queue, e);
163 memif_msg_connect_t *c = &e->msg.connect;
166 e->msg.type = MEMIF_MSG_TYPE_CONNECT;
168 s = format (0, "%U%c", format_memif_device_name, mif->dev_instance, 0);
169 strncpy ((char *) c->if_name, (char *) s, sizeof (c->if_name) - 1);
174 memif_msg_enq_connected (memif_if_t * mif)
176 memif_msg_fifo_elt_t *e;
177 clib_fifo_add2 (mif->msg_queue, e);
178 memif_msg_connected_t *c = &e->msg.connected;
181 e->msg.type = MEMIF_MSG_TYPE_CONNECTED;
183 s = format (0, "%U%c", format_memif_device_name, mif->dev_instance, 0);
184 strncpy ((char *) c->if_name, (char *) s, sizeof (c->if_name) - 1);
189 memif_msg_send_disconnect (memif_if_t * mif, clib_error_t * err)
191 memif_msg_t msg = { 0 };
192 msg.type = MEMIF_MSG_TYPE_DISCONNECT;
193 memif_msg_disconnect_t *d = &msg.disconnect;
196 strncpy ((char *) d->string, (char *) err->what, sizeof (d->string) - 1);
198 return clib_socket_sendmsg (mif->sock, &msg, sizeof (memif_msg_t), 0, 0);
201 static clib_error_t *
202 memif_msg_receive_hello (memif_if_t * mif, memif_msg_t * msg)
204 memif_msg_hello_t *h = &msg->hello;
206 if (msg->hello.min_version > MEMIF_VERSION ||
207 msg->hello.max_version < MEMIF_VERSION)
208 return clib_error_return (0, "incompatible protocol version");
210 mif->run.num_s2m_rings = clib_min (h->max_s2m_ring + 1,
211 mif->cfg.num_s2m_rings);
212 mif->run.num_m2s_rings = clib_min (h->max_m2s_ring + 1,
213 mif->cfg.num_m2s_rings);
214 mif->run.log2_ring_size = clib_min (h->max_log2_ring_size,
215 mif->cfg.log2_ring_size);
216 mif->run.buffer_size = mif->cfg.buffer_size;
218 mif->remote_name = memif_str2vec (h->name, sizeof (h->name));
223 static clib_error_t *
224 memif_msg_receive_init (memif_if_t ** mifp, memif_msg_t * msg,
225 clib_socket_t * sock, uword socket_file_index)
227 memif_main_t *mm = &memif_main;
228 memif_socket_file_t *msf =
229 vec_elt_at_index (mm->socket_files, socket_file_index);
230 memif_msg_init_t *i = &msg->init;
231 memif_if_t *mif, tmp;
235 if (i->version != MEMIF_VERSION)
237 memif_file_del_by_index (sock->private_data);
238 return clib_error_return (0, "unsupported version");
241 p = mhash_get (&msf->dev_instance_by_id, &i->id);
245 err = clib_error_return (0, "unmatched interface id");
249 mif = vec_elt_at_index (mm->interfaces, p[0]);
251 if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
253 err = clib_error_return (0, "cannot connect to slave");
259 err = clib_error_return (0, "already connected");
263 if (i->mode != mif->mode)
265 err = clib_error_return (0, "mode mismatch");
270 hash_set (msf->dev_instance_by_fd, mif->sock->fd, mif->dev_instance);
271 mif->remote_name = memif_str2vec (i->name, sizeof (i->name));
278 s = memif_str2vec (i->secret, sizeof (i->secret));
280 return clib_error_return (0, "secret required");
282 r = vec_cmp (s, mif->secret);
286 return clib_error_return (0, "incorrect secret");
293 memif_msg_send_disconnect (&tmp, err);
294 memif_socket_close (&sock);
298 static clib_error_t *
299 memif_msg_receive_add_region (memif_if_t * mif, memif_msg_t * msg, int fd)
301 memif_msg_add_region_t *ar = &msg->add_region;
304 return clib_error_return (0, "missing memory region fd");
306 if (ar->index != vec_len (mif->regions))
307 return clib_error_return (0, "unexpected region index");
309 if (ar->index > MEMIF_MAX_REGION)
310 return clib_error_return (0, "too many regions");
312 vec_validate_aligned (mif->regions, ar->index, CLIB_CACHE_LINE_BYTES);
313 mr = vec_elt_at_index (mif->regions, ar->index);
315 mr->region_size = ar->size;
320 static clib_error_t *
321 memif_msg_receive_add_ring (memif_if_t * mif, memif_msg_t * msg, int fd)
323 memif_msg_add_ring_t *ar = &msg->add_ring;
327 return clib_error_return (0, "missing ring interrupt fd");
329 if (ar->flags & MEMIF_MSG_ADD_RING_FLAG_S2M)
331 if (ar->index != vec_len (mif->rx_queues))
332 return clib_error_return (0, "unexpected ring index");
334 if (ar->index > MEMIF_MAX_S2M_RING)
335 return clib_error_return (0, "too many rings");
337 vec_validate_aligned (mif->rx_queues, ar->index, CLIB_CACHE_LINE_BYTES);
338 mq = vec_elt_at_index (mif->rx_queues, ar->index);
339 mif->run.num_s2m_rings = vec_len (mif->rx_queues);
343 if (ar->index != vec_len (mif->tx_queues))
344 return clib_error_return (0, "unexpected ring index");
346 if (ar->index > MEMIF_MAX_M2S_RING)
347 return clib_error_return (0, "too many rings");
349 vec_validate_aligned (mif->tx_queues, ar->index, CLIB_CACHE_LINE_BYTES);
350 mq = vec_elt_at_index (mif->tx_queues, ar->index);
351 mif->run.num_m2s_rings = vec_len (mif->tx_queues);
355 mq->int_clib_file_index = ~0;
356 mq->log2_ring_size = ar->log2_ring_size;
357 mq->region = ar->region;
358 mq->offset = ar->offset;
363 static clib_error_t *
364 memif_msg_receive_connect (memif_if_t * mif, memif_msg_t * msg)
367 memif_msg_connect_t *c = &msg->connect;
369 if ((err = memif_connect (mif)))
372 mif->remote_if_name = memif_str2vec (c->if_name, sizeof (c->if_name));
377 static clib_error_t *
378 memif_msg_receive_connected (memif_if_t * mif, memif_msg_t * msg)
381 memif_msg_connected_t *c = &msg->connected;
383 if ((err = memif_connect (mif)))
386 mif->remote_if_name = memif_str2vec (c->if_name, sizeof (c->if_name));
390 static clib_error_t *
391 memif_msg_receive_disconnect (memif_if_t * mif, memif_msg_t * msg)
393 memif_msg_disconnect_t *d = &msg->disconnect;
395 mif->remote_disc_string = memif_str2vec (d->string, sizeof (d->string));
396 return clib_error_return (0, "disconnect received");
399 static clib_error_t *
400 memif_msg_receive (memif_if_t ** mifp, clib_socket_t * sock, clib_file_t * uf)
402 memif_msg_t msg = { 0 };
403 clib_error_t *err = 0;
406 memif_if_t *mif = *mifp;
408 err = clib_socket_recvmsg (sock, &msg, sizeof (memif_msg_t), &fd, 1);
412 if (mif == 0 && msg.type != MEMIF_MSG_TYPE_INIT)
414 memif_socket_close (&sock);
415 return clib_error_return (0, "unexpected message received");
418 DBG ("Message type %u received", msg.type);
419 /* process the message based on its type */
422 case MEMIF_MSG_TYPE_ACK:
425 case MEMIF_MSG_TYPE_HELLO:
426 if ((err = memif_msg_receive_hello (mif, &msg)))
428 if ((err = memif_init_regions_and_queues (mif)))
430 memif_msg_enq_init (mif);
431 memif_msg_enq_add_region (mif, 0);
432 vec_foreach_index (i, mif->tx_queues)
433 memif_msg_enq_add_ring (mif, i, MEMIF_RING_S2M);
434 vec_foreach_index (i, mif->rx_queues)
435 memif_msg_enq_add_ring (mif, i, MEMIF_RING_M2S);
436 memif_msg_enq_connect (mif);
439 case MEMIF_MSG_TYPE_INIT:
440 if ((err = memif_msg_receive_init (mifp, &msg, sock, uf->private_data)))
443 vec_reset_length (uf->description);
444 uf->description = format (uf->description, "%U ctl",
445 format_memif_device_name, mif->dev_instance);
446 memif_msg_enq_ack (mif);
449 case MEMIF_MSG_TYPE_ADD_REGION:
450 if ((err = memif_msg_receive_add_region (mif, &msg, fd)))
452 memif_msg_enq_ack (mif);
455 case MEMIF_MSG_TYPE_ADD_RING:
456 if ((err = memif_msg_receive_add_ring (mif, &msg, fd)))
458 memif_msg_enq_ack (mif);
461 case MEMIF_MSG_TYPE_CONNECT:
462 if ((err = memif_msg_receive_connect (mif, &msg)))
464 memif_msg_enq_connected (mif);
467 case MEMIF_MSG_TYPE_CONNECTED:
468 if ((err = memif_msg_receive_connected (mif, &msg)))
472 case MEMIF_MSG_TYPE_DISCONNECT:
473 if ((err = memif_msg_receive_disconnect (mif, &msg)))
478 err = clib_error_return (0, "unknown message type (0x%x)", msg.type);
482 if (clib_fifo_elts (mif->msg_queue))
483 clib_file_set_data_available_to_write (&file_main,
484 mif->sock->private_data, 1);
489 memif_master_conn_fd_read_ready (clib_file_t * uf)
491 memif_main_t *mm = &memif_main;
492 memif_socket_file_t *msf =
493 pool_elt_at_index (mm->socket_files, uf->private_data);
496 clib_socket_t *sock = 0;
497 clib_error_t *err = 0;
499 p = hash_get (msf->dev_instance_by_fd, uf->file_descriptor);
502 mif = vec_elt_at_index (mm->interfaces, p[0]);
507 /* This is new connection, remove index from pending vector */
509 vec_foreach_index (i, msf->pending_clients)
510 if (msf->pending_clients[i]->fd == uf->file_descriptor)
512 sock = msf->pending_clients[i];
513 vec_del1 (msf->pending_clients, i);
518 err = memif_msg_receive (&mif, sock, uf);
521 memif_disconnect (mif, err);
522 clib_error_free (err);
528 memif_slave_conn_fd_read_ready (clib_file_t * uf)
530 memif_main_t *mm = &memif_main;
532 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data);
533 err = memif_msg_receive (&mif, mif->sock, uf);
536 memif_disconnect (mif, err);
537 clib_error_free (err);
542 static clib_error_t *
543 memif_conn_fd_write_ready (clib_file_t * uf, memif_if_t * mif)
545 memif_msg_fifo_elt_t *e;
546 clib_fifo_sub2 (mif->msg_queue, e);
547 clib_file_set_data_available_to_write (&file_main,
548 mif->sock->private_data, 0);
549 return clib_socket_sendmsg (mif->sock, &e->msg, sizeof (memif_msg_t),
550 &e->fd, e->fd > -1 ? 1 : 0);
554 memif_master_conn_fd_write_ready (clib_file_t * uf)
556 memif_main_t *mm = &memif_main;
557 memif_socket_file_t *msf =
558 pool_elt_at_index (mm->socket_files, uf->private_data);
562 p = hash_get (msf->dev_instance_by_fd, uf->file_descriptor);
566 mif = vec_elt_at_index (mm->interfaces, p[0]);
567 return memif_conn_fd_write_ready (uf, mif);
571 memif_slave_conn_fd_write_ready (clib_file_t * uf)
573 memif_main_t *mm = &memif_main;
574 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data);
575 return memif_conn_fd_write_ready (uf, mif);
579 memif_slave_conn_fd_error (clib_file_t * uf)
581 memif_main_t *mm = &memif_main;
582 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data);
585 err = clib_error_return (0, "connection fd error");
586 memif_disconnect (mif, err);
587 clib_error_free (err);
593 memif_master_conn_fd_error (clib_file_t * uf)
595 memif_main_t *mm = &memif_main;
596 memif_socket_file_t *msf =
597 pool_elt_at_index (mm->socket_files, uf->private_data);
601 p = hash_get (msf->dev_instance_by_fd, uf->file_descriptor);
606 mif = vec_elt_at_index (mm->interfaces, p[0]);
607 err = clib_error_return (0, "connection fd error");
608 memif_disconnect (mif, err);
609 clib_error_free (err);
614 vec_foreach_index (i, msf->pending_clients)
615 if (msf->pending_clients[i]->fd == uf->file_descriptor)
617 clib_socket_t *s = msf->pending_clients[i];
618 memif_socket_close (&s);
619 vec_del1 (msf->pending_clients, i);
624 clib_warning ("Error on unknown file descriptor %d", uf->file_descriptor);
631 memif_conn_fd_accept_ready (clib_file_t * uf)
633 memif_main_t *mm = &memif_main;
634 memif_socket_file_t *msf =
635 pool_elt_at_index (mm->socket_files, uf->private_data);
636 clib_file_t template = { 0 };
638 clib_socket_t *client;
640 client = clib_mem_alloc (sizeof (clib_socket_t));
641 memset (client, 0, sizeof (clib_socket_t));
642 err = clib_socket_accept (msf->sock, client);
646 template.read_function = memif_master_conn_fd_read_ready;
647 template.write_function = memif_master_conn_fd_write_ready;
648 template.error_function = memif_master_conn_fd_error;
649 template.file_descriptor = client->fd;
650 template.private_data = uf->private_data;
651 template.description = format (0, "memif in conn on %s", msf->filename);
653 memif_file_add (&client->private_data, &template);
655 err = memif_msg_enq_hello (client);
658 clib_socket_close (client);
662 vec_add1 (msf->pending_clients, client);
667 clib_error_report (err);
668 clib_mem_free (client);
673 * fd.io coding-style-patch-verification: ON
676 * eval: (c-set-style "gnu")