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 clib_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_msg_t msg = { 0 };
412 clib_error_t *err = 0;
415 memif_if_t *mif = *mifp;
417 err = clib_socket_recvmsg (sock, &msg, sizeof (memif_msg_t), &fd, 1);
421 if (mif == 0 && msg.type != MEMIF_MSG_TYPE_INIT)
423 memif_socket_close (&sock);
424 err = clib_error_return (0, "unexpected message received");
428 memif_log_debug (mif, "Message type %u received", msg.type);
429 /* process the message based on its type */
432 case MEMIF_MSG_TYPE_ACK:
435 case MEMIF_MSG_TYPE_HELLO:
436 if ((err = memif_msg_receive_hello (mif, &msg)))
438 if ((err = memif_init_regions_and_queues (mif)))
440 memif_msg_enq_init (mif);
442 vec_foreach_index (i, mif->regions)
443 memif_msg_enq_add_region (mif, i);
444 vec_foreach_index (i, mif->tx_queues)
445 memif_msg_enq_add_ring (mif, i, MEMIF_RING_S2M);
446 vec_foreach_index (i, mif->rx_queues)
447 memif_msg_enq_add_ring (mif, i, MEMIF_RING_M2S);
449 memif_msg_enq_connect (mif);
452 case MEMIF_MSG_TYPE_INIT:
453 if ((err = memif_msg_receive_init (mifp, &msg, sock, uf->private_data)))
456 vec_reset_length (uf->description);
457 uf->description = format (uf->description, "%U ctl",
458 format_memif_device_name, mif->dev_instance);
459 memif_msg_enq_ack (mif);
462 case MEMIF_MSG_TYPE_ADD_REGION:
463 if ((err = memif_msg_receive_add_region (mif, &msg, fd)))
465 memif_msg_enq_ack (mif);
468 case MEMIF_MSG_TYPE_ADD_RING:
469 if ((err = memif_msg_receive_add_ring (mif, &msg, fd)))
471 memif_msg_enq_ack (mif);
474 case MEMIF_MSG_TYPE_CONNECT:
475 if ((err = memif_msg_receive_connect (mif, &msg)))
477 memif_msg_enq_connected (mif);
480 case MEMIF_MSG_TYPE_CONNECTED:
481 if ((err = memif_msg_receive_connected (mif, &msg)))
485 case MEMIF_MSG_TYPE_DISCONNECT:
486 if ((err = memif_msg_receive_disconnect (mif, &msg)))
491 err = clib_error_return (0, "unknown message type (0x%x)", msg.type);
495 if (clib_fifo_elts (mif->msg_queue))
496 clib_file_set_data_available_to_write (&file_main,
497 mif->sock->private_data, 1);
501 memif_log_err (mif, "%U", format_clib_error, err);
506 memif_master_conn_fd_read_ready (clib_file_t * uf)
508 memif_main_t *mm = &memif_main;
509 memif_socket_file_t *msf =
510 pool_elt_at_index (mm->socket_files, uf->private_data);
513 clib_socket_t *sock = 0;
514 clib_error_t *err = 0;
516 p = hash_get (msf->dev_instance_by_fd, uf->file_descriptor);
519 mif = vec_elt_at_index (mm->interfaces, p[0]);
524 /* This is new connection, remove index from pending vector */
526 vec_foreach_index (i, msf->pending_clients)
527 if (msf->pending_clients[i]->fd == uf->file_descriptor)
529 sock = msf->pending_clients[i];
530 vec_del1 (msf->pending_clients, i);
535 err = memif_msg_receive (&mif, sock, uf);
538 memif_disconnect (mif, err);
539 clib_error_free (err);
545 memif_slave_conn_fd_read_ready (clib_file_t * uf)
547 memif_main_t *mm = &memif_main;
549 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data);
550 err = memif_msg_receive (&mif, mif->sock, uf);
553 memif_disconnect (mif, err);
554 clib_error_free (err);
559 static clib_error_t *
560 memif_conn_fd_write_ready (clib_file_t * uf, memif_if_t * mif)
562 memif_msg_fifo_elt_t *e;
563 clib_fifo_sub2 (mif->msg_queue, e);
564 clib_file_set_data_available_to_write (&file_main,
565 mif->sock->private_data, 0);
566 return clib_socket_sendmsg (mif->sock, &e->msg, sizeof (memif_msg_t),
567 &e->fd, e->fd > -1 ? 1 : 0);
571 memif_master_conn_fd_write_ready (clib_file_t * uf)
573 memif_main_t *mm = &memif_main;
574 memif_socket_file_t *msf =
575 pool_elt_at_index (mm->socket_files, uf->private_data);
579 p = hash_get (msf->dev_instance_by_fd, uf->file_descriptor);
583 mif = vec_elt_at_index (mm->interfaces, p[0]);
584 return memif_conn_fd_write_ready (uf, mif);
588 memif_slave_conn_fd_write_ready (clib_file_t * uf)
590 memif_main_t *mm = &memif_main;
591 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data);
592 return memif_conn_fd_write_ready (uf, mif);
596 memif_slave_conn_fd_error (clib_file_t * uf)
598 memif_main_t *mm = &memif_main;
599 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data);
602 err = clib_error_return (0, "connection fd error");
603 memif_disconnect (mif, err);
604 clib_error_free (err);
610 memif_master_conn_fd_error (clib_file_t * uf)
612 memif_main_t *mm = &memif_main;
613 memif_socket_file_t *msf =
614 pool_elt_at_index (mm->socket_files, uf->private_data);
618 p = hash_get (msf->dev_instance_by_fd, uf->file_descriptor);
623 mif = vec_elt_at_index (mm->interfaces, p[0]);
624 err = clib_error_return (0, "connection fd error");
625 memif_disconnect (mif, err);
626 clib_error_free (err);
631 vec_foreach_index (i, msf->pending_clients)
632 if (msf->pending_clients[i]->fd == uf->file_descriptor)
634 clib_socket_t *s = msf->pending_clients[i];
635 memif_socket_close (&s);
636 vec_del1 (msf->pending_clients, i);
641 memif_log_warn (0, "Error on unknown file descriptor %d",
642 uf->file_descriptor);
649 memif_conn_fd_accept_ready (clib_file_t * uf)
651 memif_main_t *mm = &memif_main;
652 memif_socket_file_t *msf =
653 pool_elt_at_index (mm->socket_files, uf->private_data);
654 clib_file_t template = { 0 };
656 clib_socket_t *client;
658 client = clib_mem_alloc (sizeof (clib_socket_t));
659 clib_memset (client, 0, sizeof (clib_socket_t));
660 err = clib_socket_accept (msf->sock, client);
664 template.read_function = memif_master_conn_fd_read_ready;
665 template.write_function = memif_master_conn_fd_write_ready;
666 template.error_function = memif_master_conn_fd_error;
667 template.file_descriptor = client->fd;
668 template.private_data = uf->private_data;
669 template.description = format (0, "memif in conn on %s", msf->filename);
671 memif_file_add (&client->private_data, &template);
673 err = memif_msg_enq_hello (client);
676 clib_socket_close (client);
680 vec_add1 (msf->pending_clients, client);
685 memif_log_err (0, "%U", format_clib_error, err);
686 clib_mem_free (client);
691 * fd.io coding-style-patch-verification: ON
694 * eval: (c-set-style "gnu")