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_str2vec (uint8_t * str, int len)
51 for (i = 0; i < len; i++)
63 memif_msg_send (int fd, memif_msg_t * msg, int afd)
65 struct msghdr mh = { 0 };
67 char ctl[CMSG_SPACE (sizeof (int))];
70 iov[0].iov_base = (void *) msg;
71 iov[0].iov_len = sizeof (memif_msg_t);
78 memset (&ctl, 0, sizeof (ctl));
80 mh.msg_controllen = sizeof (ctl);
81 cmsg = CMSG_FIRSTHDR (&mh);
82 cmsg->cmsg_len = CMSG_LEN (sizeof (int));
83 cmsg->cmsg_level = SOL_SOCKET;
84 cmsg->cmsg_type = SCM_RIGHTS;
85 memcpy (CMSG_DATA (cmsg), &afd, sizeof (int));
87 rv = sendmsg (fd, &mh, 0);
89 return clib_error_return_unix (0, "sendmsg");
90 DBG ("Message type %u sent (fd %d)", msg->type, afd);
95 memif_msg_enq_ack (memif_if_t * mif)
97 memif_msg_fifo_elt_t *e;
98 clib_fifo_add2 (mif->msg_queue, e);
100 e->msg.type = MEMIF_MSG_TYPE_ACK;
104 static clib_error_t *
105 memif_msg_enq_hello (int fd)
108 memif_msg_t msg = { 0 };
109 memif_msg_hello_t *h = &msg.hello;
110 msg.type = MEMIF_MSG_TYPE_HELLO;
111 h->min_version = MEMIF_VERSION;
112 h->max_version = MEMIF_VERSION;
113 h->max_m2s_ring = MEMIF_MAX_M2S_RING;
114 h->max_s2m_ring = MEMIF_MAX_M2S_RING;
115 h->max_region = MEMIF_MAX_REGION;
116 h->max_log2_ring_size = MEMIF_MAX_LOG2_RING_SIZE;
117 s = format (0, "VPP %s%c", VPP_BUILD_VER, 0);
118 strncpy ((char *) h->name, (char *) s, sizeof (h->name));
120 return memif_msg_send (fd, &msg, -1);
124 memif_msg_enq_init (memif_if_t * mif)
127 memif_msg_fifo_elt_t *e;
128 clib_fifo_add2 (mif->msg_queue, e);
129 memif_msg_init_t *i = &e->msg.init;
131 e->msg.type = MEMIF_MSG_TYPE_INIT;
133 i->version = MEMIF_VERSION;
136 s = format (0, "VPP %s%c", VPP_BUILD_VER, 0);
137 strncpy ((char *) i->name, (char *) s, sizeof (i->name));
139 strncpy ((char *) i->secret, (char *) mif->secret, sizeof (i->secret));
144 memif_msg_enq_add_region (memif_if_t * mif, u8 region)
146 memif_msg_fifo_elt_t *e;
147 clib_fifo_add2 (mif->msg_queue, e);
148 memif_msg_add_region_t *ar = &e->msg.add_region;
150 e->msg.type = MEMIF_MSG_TYPE_ADD_REGION;
151 e->fd = mif->regions[region].fd;
153 ar->size = mif->regions[region].region_size;
157 memif_msg_enq_add_ring (memif_if_t * mif, u8 index, u8 direction)
159 memif_msg_fifo_elt_t *e;
160 clib_fifo_add2 (mif->msg_queue, e);
161 memif_msg_add_ring_t *ar = &e->msg.add_ring;
164 ASSERT ((mif->flags & MEMIF_IF_FLAG_IS_SLAVE) != 0);
166 e->msg.type = MEMIF_MSG_TYPE_ADD_RING;
168 if (direction == MEMIF_RING_M2S)
169 mq = vec_elt_at_index (mif->rx_queues, index);
171 mq = vec_elt_at_index (mif->tx_queues, index);
175 ar->region = mq->region;
176 ar->offset = mq->offset;
177 ar->log2_ring_size = mq->log2_ring_size;
178 ar->flags = (direction == MEMIF_RING_S2M) ? MEMIF_MSG_ADD_RING_FLAG_S2M : 0;
182 memif_msg_enq_connect (memif_if_t * mif)
184 memif_msg_fifo_elt_t *e;
185 clib_fifo_add2 (mif->msg_queue, e);
186 memif_msg_connect_t *c = &e->msg.connect;
189 e->msg.type = MEMIF_MSG_TYPE_CONNECT;
191 s = format (0, "%U%c", format_memif_device_name, mif->dev_instance, 0);
192 strncpy ((char *) c->if_name, (char *) s, sizeof (c->if_name));
197 memif_msg_enq_connected (memif_if_t * mif)
199 memif_msg_fifo_elt_t *e;
200 clib_fifo_add2 (mif->msg_queue, e);
201 memif_msg_connected_t *c = &e->msg.connected;
204 e->msg.type = MEMIF_MSG_TYPE_CONNECTED;
206 s = format (0, "%U%c", format_memif_device_name, mif->dev_instance, 0);
207 strncpy ((char *) c->if_name, (char *) s, sizeof (c->if_name));
212 memif_msg_send_disconnect (memif_if_t * mif, clib_error_t * err)
214 memif_msg_t msg = { 0 };
215 msg.type = MEMIF_MSG_TYPE_DISCONNECT;
216 memif_msg_disconnect_t *d = &msg.disconnect;
219 strncpy ((char *) d->string, (char *) err->what, sizeof (d->string));
221 return memif_msg_send (mif->conn_fd, &msg, -1);
224 static clib_error_t *
225 memif_msg_receive_hello (memif_if_t * mif, memif_msg_t * msg)
227 memif_msg_hello_t *h = &msg->hello;
229 if (msg->hello.min_version > MEMIF_VERSION ||
230 msg->hello.max_version < MEMIF_VERSION)
231 return clib_error_return (0, "incompatible protocol version");
233 mif->run.num_s2m_rings = clib_min (h->max_s2m_ring + 1,
234 mif->cfg.num_s2m_rings);
235 mif->run.num_m2s_rings = clib_min (h->max_m2s_ring + 1,
236 mif->cfg.num_m2s_rings);
237 mif->run.log2_ring_size = clib_min (h->max_log2_ring_size,
238 mif->cfg.log2_ring_size);
239 mif->run.buffer_size = mif->cfg.buffer_size;
241 mif->remote_name = memif_str2vec (h->name, sizeof (h->name));
246 static clib_error_t *
247 memif_msg_receive_init (memif_if_t ** mifp, memif_msg_t * msg,
250 memif_main_t *mm = &memif_main;
251 memif_socket_file_t *msf =
252 vec_elt_at_index (mm->socket_files, uf->private_data);
253 memif_msg_init_t *i = &msg->init;
254 memif_if_t *mif, tmp;
258 if (i->version != MEMIF_VERSION)
260 memif_file_del_by_index (uf - unix_main.file_pool);
261 return clib_error_return (0, "unsupported version");
264 p = mhash_get (&msf->dev_instance_by_id, &i->id);
268 err = clib_error_return (0, "unmatched interface id");
272 mif = vec_elt_at_index (mm->interfaces, p[0]);
274 if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
276 err = clib_error_return (0, "cannot connect to slave");
280 if (mif->conn_fd != -1)
282 err = clib_error_return (0, "already connected");
286 if (i->mode != mif->mode)
288 err = clib_error_return (0, "mode mismatch");
292 mif->conn_fd = uf->file_descriptor;
293 mif->conn_unix_file_index = uf - unix_main.file_pool;
294 hash_set (msf->dev_instance_by_fd, mif->conn_fd, mif->dev_instance);
295 mif->remote_name = memif_str2vec (i->name, sizeof (i->name));
302 s = memif_str2vec (i->secret, sizeof (i->secret));
304 return clib_error_return (0, "secret required");
306 r = vec_cmp (s, mif->secret);
310 return clib_error_return (0, "incorrect secret");
316 tmp.conn_fd = uf->file_descriptor;
317 memif_msg_send_disconnect (&tmp, err);
318 memif_file_del_by_index (uf - unix_main.file_pool);
322 static clib_error_t *
323 memif_msg_receive_add_region (memif_if_t * mif, memif_msg_t * msg, int fd)
325 memif_msg_add_region_t *ar = &msg->add_region;
328 return clib_error_return (0, "missing memory region fd");
330 if (ar->index != vec_len (mif->regions))
331 return clib_error_return (0, "unexpected region index");
333 if (ar->index > MEMIF_MAX_REGION)
334 return clib_error_return (0, "too many regions");
336 vec_validate_aligned (mif->regions, ar->index, CLIB_CACHE_LINE_BYTES);
337 mr = vec_elt_at_index (mif->regions, ar->index);
339 mr->region_size = ar->size;
344 static clib_error_t *
345 memif_msg_receive_add_ring (memif_if_t * mif, memif_msg_t * msg, int fd)
347 memif_msg_add_ring_t *ar = &msg->add_ring;
351 return clib_error_return (0, "missing ring interrupt fd");
353 if (ar->flags & MEMIF_MSG_ADD_RING_FLAG_S2M)
355 if (ar->index != vec_len (mif->rx_queues))
356 return clib_error_return (0, "unexpected ring index");
358 if (ar->index > MEMIF_MAX_S2M_RING)
359 return clib_error_return (0, "too many rings");
361 vec_validate_aligned (mif->rx_queues, ar->index, CLIB_CACHE_LINE_BYTES);
362 mq = vec_elt_at_index (mif->rx_queues, ar->index);
363 mif->run.num_s2m_rings = vec_len (mif->rx_queues);
367 if (ar->index != vec_len (mif->tx_queues))
368 return clib_error_return (0, "unexpected ring index");
370 if (ar->index > MEMIF_MAX_M2S_RING)
371 return clib_error_return (0, "too many rings");
373 vec_validate_aligned (mif->tx_queues, ar->index, CLIB_CACHE_LINE_BYTES);
374 mq = vec_elt_at_index (mif->tx_queues, ar->index);
375 mif->run.num_m2s_rings = vec_len (mif->tx_queues);
379 mq->int_unix_file_index = ~0;
380 mq->log2_ring_size = ar->log2_ring_size;
381 mq->region = ar->region;
382 mq->offset = ar->offset;
387 static clib_error_t *
388 memif_msg_receive_connect (memif_if_t * mif, memif_msg_t * msg)
391 memif_msg_connect_t *c = &msg->connect;
393 if ((err = memif_connect (mif)))
396 mif->remote_if_name = memif_str2vec (c->if_name, sizeof (c->if_name));
401 static clib_error_t *
402 memif_msg_receive_connected (memif_if_t * mif, memif_msg_t * msg)
405 memif_msg_connected_t *c = &msg->connected;
407 if ((err = memif_connect (mif)))
410 mif->remote_if_name = memif_str2vec (c->if_name, sizeof (c->if_name));
414 static clib_error_t *
415 memif_msg_receive_disconnect (memif_if_t * mif, memif_msg_t * msg)
417 memif_msg_disconnect_t *d = &msg->disconnect;
419 mif->remote_disc_string = memif_str2vec (d->string, sizeof (d->string));
420 return clib_error_return (0, "disconnect received");
423 static clib_error_t *
424 memif_msg_receive (memif_if_t ** mifp, unix_file_t * uf)
426 char ctl[CMSG_SPACE (sizeof (int)) +
427 CMSG_SPACE (sizeof (struct ucred))] = { 0 };
428 struct msghdr mh = { 0 };
430 memif_msg_t msg = { 0 };
432 clib_error_t *err = 0;
435 memif_if_t *mif = *mifp;
437 iov[0].iov_base = (void *) &msg;
438 iov[0].iov_len = sizeof (memif_msg_t);
441 mh.msg_control = ctl;
442 mh.msg_controllen = sizeof (ctl);
444 /* receive the incoming message */
445 size = recvmsg (uf->file_descriptor, &mh, 0);
446 if (size != sizeof (memif_msg_t))
448 return (size == 0) ? clib_error_return (0, "disconnected") :
449 clib_error_return_unix (0,
450 "recvmsg: malformed message received on fd %d",
451 uf->file_descriptor);
454 if (mif == 0 && msg.type != MEMIF_MSG_TYPE_INIT)
457 return clib_error_return (0, "unexpected message received");
460 /* process anciliary data */
461 struct ucred *cr = 0;
462 struct cmsghdr *cmsg;
464 cmsg = CMSG_FIRSTHDR (&mh);
467 if (cmsg->cmsg_level == SOL_SOCKET)
469 if (cmsg->cmsg_type == SCM_CREDENTIALS)
471 cr = (struct ucred *) CMSG_DATA (cmsg);
473 else if (cmsg->cmsg_type == SCM_RIGHTS)
475 int *fdp = (int *) CMSG_DATA (cmsg);
479 cmsg = CMSG_NXTHDR (&mh, cmsg);
482 DBG ("Message type %u received", msg.type);
483 /* process the message based on its type */
486 case MEMIF_MSG_TYPE_ACK:
489 case MEMIF_MSG_TYPE_HELLO:
490 if ((err = memif_msg_receive_hello (mif, &msg)))
492 if ((err = memif_init_regions_and_queues (mif)))
494 memif_msg_enq_init (mif);
495 memif_msg_enq_add_region (mif, 0);
496 vec_foreach_index (i, mif->tx_queues)
497 memif_msg_enq_add_ring (mif, i, MEMIF_RING_S2M);
498 vec_foreach_index (i, mif->rx_queues)
499 memif_msg_enq_add_ring (mif, i, MEMIF_RING_M2S);
500 memif_msg_enq_connect (mif);
503 case MEMIF_MSG_TYPE_INIT:
504 if ((err = memif_msg_receive_init (mifp, &msg, uf)))
507 mif->remote_pid = cr->pid;
508 mif->remote_uid = cr->uid;
509 mif->remote_gid = cr->gid;
510 memif_msg_enq_ack (mif);
513 case MEMIF_MSG_TYPE_ADD_REGION:
514 if ((err = memif_msg_receive_add_region (mif, &msg, fd)))
516 memif_msg_enq_ack (mif);
519 case MEMIF_MSG_TYPE_ADD_RING:
520 if ((err = memif_msg_receive_add_ring (mif, &msg, fd)))
522 memif_msg_enq_ack (mif);
525 case MEMIF_MSG_TYPE_CONNECT:
526 if ((err = memif_msg_receive_connect (mif, &msg)))
528 memif_msg_enq_connected (mif);
531 case MEMIF_MSG_TYPE_CONNECTED:
532 if ((err = memif_msg_receive_connected (mif, &msg)))
536 case MEMIF_MSG_TYPE_DISCONNECT:
537 if ((err = memif_msg_receive_disconnect (mif, &msg)))
542 err = clib_error_return (0, "unknown message type (0x%x)", msg.type);
546 if (clib_fifo_elts (mif->msg_queue) && mif->conn_unix_file_index != ~0)
547 unix_file_set_data_available_to_write (mif->conn_unix_file_index, 1);
552 memif_master_conn_fd_read_ready (unix_file_t * uf)
554 memif_main_t *mm = &memif_main;
555 memif_socket_file_t *msf =
556 pool_elt_at_index (mm->socket_files, uf->private_data);
559 uword conn_unix_file_index = ~0;
560 clib_error_t *err = 0;
562 p = hash_get (msf->dev_instance_by_fd, uf->file_descriptor);
565 mif = vec_elt_at_index (mm->interfaces, p[0]);
569 /* This is new connection, remove index from pending vector */
571 vec_foreach_index (i, msf->pending_file_indices)
572 if (msf->pending_file_indices[i] == uf - unix_main.file_pool)
574 conn_unix_file_index = msf->pending_file_indices[i];
575 vec_del1 (msf->pending_file_indices, i);
578 ASSERT (conn_unix_file_index != ~0);
580 err = memif_msg_receive (&mif, uf);
583 memif_disconnect (mif, err);
584 clib_error_free (err);
590 memif_slave_conn_fd_read_ready (unix_file_t * uf)
592 memif_main_t *mm = &memif_main;
594 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data);
595 err = memif_msg_receive (&mif, uf);
598 memif_disconnect (mif, err);
599 clib_error_free (err);
604 static clib_error_t *
605 memif_conn_fd_write_ready (unix_file_t * uf, memif_if_t * mif)
607 memif_msg_fifo_elt_t *e;
608 clib_fifo_sub2 (mif->msg_queue, e);
609 unix_file_set_data_available_to_write (mif->conn_unix_file_index, 0);
610 memif_msg_send (mif->conn_fd, &e->msg, e->fd);
615 memif_master_conn_fd_write_ready (unix_file_t * uf)
617 memif_main_t *mm = &memif_main;
618 memif_socket_file_t *msf =
619 pool_elt_at_index (mm->socket_files, uf->private_data);
623 p = hash_get (msf->dev_instance_by_fd, uf->file_descriptor);
627 mif = vec_elt_at_index (mm->interfaces, p[0]);
628 return memif_conn_fd_write_ready (uf, mif);
632 memif_slave_conn_fd_write_ready (unix_file_t * uf)
634 memif_main_t *mm = &memif_main;
635 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data);
636 return memif_conn_fd_write_ready (uf, mif);
640 memif_slave_conn_fd_error (unix_file_t * uf)
642 memif_main_t *mm = &memif_main;
643 memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data);
646 err = clib_error_return (0, "connection fd error");
647 memif_disconnect (mif, err);
648 clib_error_free (err);
654 memif_master_conn_fd_error (unix_file_t * uf)
656 memif_main_t *mm = &memif_main;
657 memif_socket_file_t *msf =
658 pool_elt_at_index (mm->socket_files, uf->private_data);
662 p = hash_get (msf->dev_instance_by_fd, uf->file_descriptor);
667 mif = vec_elt_at_index (mm->interfaces, p[0]);
668 err = clib_error_return (0, "connection fd error");
669 memif_disconnect (mif, err);
670 clib_error_free (err);
675 vec_foreach_index (i, msf->pending_file_indices)
676 if (msf->pending_file_indices[i] == uf - unix_main.file_pool)
678 vec_del1 (msf->pending_file_indices, i);
684 clib_warning ("Error on unknown file descriptor %d", uf->file_descriptor);
691 memif_conn_fd_accept_ready (unix_file_t * uf)
693 memif_main_t *mm = &memif_main;
694 memif_socket_file_t *msf =
695 pool_elt_at_index (mm->socket_files, uf->private_data);
697 struct sockaddr_un client;
699 unix_file_t template = { 0 };
700 uword unix_file_index = ~0;
704 addr_len = sizeof (client);
705 conn_fd = accept (uf->file_descriptor,
706 (struct sockaddr *) &client, (socklen_t *) & addr_len);
709 return clib_error_return_unix (0, "accept fd %d", uf->file_descriptor);
711 template.read_function = memif_master_conn_fd_read_ready;
712 template.write_function = memif_master_conn_fd_write_ready;
713 template.error_function = memif_master_conn_fd_error;
714 template.file_descriptor = conn_fd;
715 template.private_data = uf->private_data;
717 memif_file_add (&unix_file_index, &template);
719 err = memif_msg_enq_hello (conn_fd);
722 clib_error_report (err);
723 memif_file_del_by_index (unix_file_index);
726 vec_add1 (msf->pending_file_indices, unix_file_index);
732 * fd.io coding-style-patch-verification: ON
735 * eval: (c-set-style "gnu")