src/plugins/memif/memif.c

   1 /*
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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  *------------------------------------------------------------------
  16  */
  17
  18 #define _GNU_SOURCE
  19 #include <stdint.h>
  20 #include <net/if.h>
  21 #include <sys/types.h>
  22 #include <fcntl.h>
  23 #include <sys/ioctl.h>
  24 #include <sys/socket.h>
  25 #include <sys/un.h>
  26 #include <sys/uio.h>
  27 #include <sys/mman.h>
  28 #include <sys/prctl.h>
  29 #include <inttypes.h>
  30
  31 #include <vlib/vlib.h>
  32 #include <vlib/unix/unix.h>
  33 #include <vnet/plugin/plugin.h>
  34 #include <vnet/ethernet/ethernet.h>
  35 #include <vpp/app/version.h>
  36 #include <memif/memif.h>
  37
  38 #define MEMIF_DEBUG 1
  39
  40 #if MEMIF_DEBUG == 1
  41 #define DEBUG_LOG(...) clib_warning(__VA_ARGS__)
  42 #define DEBUG_UNIX_LOG(...) clib_unix_warning(__VA_ARGS__)
  43 #else
  44 #define DEBUG_LOG(...)
  45 #endif
  46
  47 memif_main_t memif_main;
  48
  49 static clib_error_t *memif_conn_fd_read_ready (unix_file_t * uf);
  50 static clib_error_t *memif_int_fd_read_ready (unix_file_t * uf);
  51
  52 static u32
  53 memif_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi, u32 flags)
  54 {
  55   /* nothing for now */
  56   return 0;
  57 }
  58
  59 static void
  60 memif_remove_pending_conn (memif_pending_conn_t * pending_conn)
  61 {
  62   memif_main_t *mm = &memif_main;
  63
  64   unix_file_del (&unix_main,
  65                  unix_main.file_pool + pending_conn->connection.index);
  66   pool_put (mm->pending_conns, pending_conn);
  67 }
  68
  69 static void
  70 memif_connect (vlib_main_t * vm, memif_if_t * mif)
  71 {
  72   vnet_main_t *vnm = vnet_get_main ();
  73   int num_rings = mif->num_s2m_rings + mif->num_m2s_rings;
  74   memif_ring_data_t *rd = NULL;
  75
  76   vec_validate_aligned (mif->ring_data, num_rings - 1, CLIB_CACHE_LINE_BYTES);
  77   vec_foreach (rd, mif->ring_data)
  78   {
  79     rd->last_head = 0;
  80   }
  81
  82   mif->flags &= ~MEMIF_IF_FLAG_CONNECTING;
  83   mif->flags |= MEMIF_IF_FLAG_CONNECTED;
  84   vnet_hw_interface_set_flags (vnm, mif->hw_if_index,
  85                                VNET_HW_INTERFACE_FLAG_LINK_UP);
  86 }
  87
  88 void
  89 memif_disconnect (vlib_main_t * vm, memif_if_t * mif)
  90 {
  91   vnet_main_t *vnm = vnet_get_main ();
  92
  93   mif->flags &= ~(MEMIF_IF_FLAG_CONNECTED | MEMIF_IF_FLAG_CONNECTING);
  94   if (mif->hw_if_index != ~0)
  95     vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
  96
  97   if (mif->interrupt_line.index != ~0)
  98     {
  99       unix_file_del (&unix_main,
 100                      unix_main.file_pool + mif->interrupt_line.index);
 101       mif->interrupt_line.index = ~0;
 102       mif->interrupt_line.fd = -1;      /* closed in unix_file_del */
 103     }
 104   if (mif->connection.index != ~0)
 105     {
 106       unix_file_del (&unix_main, unix_main.file_pool + mif->connection.index);
 107       mif->connection.index = ~0;
 108       mif->connection.fd = -1;  /* closed in unix_file_del */
 109     }
 110
 111   // TODO: properly munmap + close memif-owned shared memory segments
 112   vec_free (mif->regions);
 113 }
 114
 115 static clib_error_t *
 116 memif_process_connect_req (memif_pending_conn_t * pending_conn,
 117                            memif_msg_t * req, struct ucred *slave_cr,
 118                            int shm_fd, int int_fd)
 119 {
 120   memif_main_t *mm = &memif_main;
 121   vlib_main_t *vm = vlib_get_main ();
 122   int fd = pending_conn->connection.fd;
 123   unix_file_t *uf = 0;
 124   memif_if_t *mif = 0;
 125   memif_msg_t resp = { 0 };
 126   unix_file_t template = { 0 };
 127   void *shm;
 128   uword *p;
 129   u8 retval = 0;
 130   static clib_error_t *error = 0;
 131
 132   if (shm_fd == -1)
 133     {
 134       DEBUG_LOG
 135         ("Connection request is missing shared memory file descriptor");
 136       retval = 1;
 137       goto response;
 138     }
 139
 140   if (int_fd == -1)
 141     {
 142       DEBUG_LOG
 143         ("Connection request is missing interrupt line file descriptor");
 144       retval = 2;
 145       goto response;
 146     }
 147
 148   if (slave_cr == NULL)
 149     {
 150       DEBUG_LOG ("Connection request is missing slave credentials");
 151       retval = 3;
 152       goto response;
 153     }
 154
 155   p = mhash_get (&mm->if_index_by_key, &req->key);
 156   if (!p)
 157     {
 158       DEBUG_LOG
 159         ("Connection request with unmatched key (0x%" PRIx64 ")", req->key);
 160       retval = 4;
 161       goto response;
 162     }
 163
 164   mif = vec_elt_at_index (mm->interfaces, *p);
 165   if (mif->listener_index != pending_conn->listener_index)
 166     {
 167       DEBUG_LOG
 168         ("Connection request with non-matching listener (%d vs. %d)",
 169          pending_conn->listener_index, mif->listener_index);
 170       retval = 5;
 171       goto response;
 172     }
 173
 174   if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
 175     {
 176       DEBUG_LOG ("Memif slave does not accept connection requests");
 177       retval = 6;
 178       goto response;
 179     }
 180
 181   if (mif->connection.fd != -1)
 182     {
 183       DEBUG_LOG
 184         ("Memif with key 0x%" PRIx64 " is already connected", mif->key);
 185       retval = 7;
 186       goto response;
 187     }
 188
 189   if ((mif->flags & MEMIF_IF_FLAG_ADMIN_UP) == 0)
 190     {
 191       /* just silently decline the request */
 192       retval = 8;
 193       goto response;
 194     }
 195
 196   if (req->shared_mem_size < sizeof (memif_shm_t))
 197     {
 198       DEBUG_LOG
 199         ("Unexpectedly small shared memory segment received from slave.");
 200       retval = 9;
 201       goto response;
 202     }
 203
 204   if ((shm =
 205        mmap (NULL, req->shared_mem_size, PROT_READ | PROT_WRITE, MAP_SHARED,
 206              shm_fd, 0)) == MAP_FAILED)
 207     {
 208       DEBUG_UNIX_LOG
 209         ("Failed to map shared memory segment received from slave memif");
 210       error = clib_error_return_unix (0, "mmap fd %d", shm_fd);
 211       retval = 10;
 212       goto response;
 213     }
 214
 215   if (((memif_shm_t *) shm)->cookie != 0xdeadbeef)
 216     {
 217       DEBUG_LOG
 218         ("Possibly corrupted shared memory segment received from slave memif");
 219       munmap (shm, req->shared_mem_size);
 220       retval = 11;
 221       goto response;
 222     }
 223
 224   mif->log2_ring_size = req->log2_ring_size;
 225   mif->num_s2m_rings = req->num_s2m_rings;
 226   mif->num_m2s_rings = req->num_m2s_rings;
 227   mif->buffer_size = req->buffer_size;
 228   mif->remote_pid = slave_cr->pid;
 229   mif->remote_uid = slave_cr->uid;
 230   vec_add1 (mif->regions, shm);
 231
 232   /* register interrupt line */
 233   mif->interrupt_line.fd = int_fd;
 234   template.read_function = memif_int_fd_read_ready;
 235   template.file_descriptor = int_fd;
 236   template.private_data = mif->if_index;
 237   mif->interrupt_line.index = unix_file_add (&unix_main, &template);
 238
 239   /* change context for future messages */
 240   uf = vec_elt_at_index (unix_main.file_pool, pending_conn->connection.index);
 241   uf->private_data = mif->if_index << 1;
 242   mif->connection = pending_conn->connection;
 243   pool_put (mm->pending_conns, pending_conn);
 244
 245   memif_connect (vm, mif);
 246
 247 response:
 248   resp.version = MEMIF_VERSION;
 249   resp.type = MEMIF_MSG_TYPE_CONNECT_RESP;
 250   resp.retval = retval;
 251   if (send (fd, &resp, sizeof (resp), 0) < 0)
 252     {
 253       DEBUG_UNIX_LOG ("Failed to send connection response");
 254       error = clib_error_return_unix (0, "send fd %d", fd);
 255       memif_disconnect (vm, mif);
 256     }
 257   return error;
 258 }
 259
 260 static clib_error_t *
 261 memif_process_connect_resp (memif_if_t * mif, memif_msg_t * resp)
 262 {
 263   vlib_main_t *vm = vlib_get_main ();
 264
 265   if ((mif->flags & MEMIF_IF_FLAG_IS_SLAVE) == 0)
 266     {
 267       DEBUG_LOG ("Memif master does not accept connection responses");
 268       return 0;
 269     }
 270
 271   if ((mif->flags & MEMIF_IF_FLAG_CONNECTING) == 0)
 272     {
 273       DEBUG_LOG ("Unexpected connection response");
 274       return 0;
 275     }
 276
 277   if (resp->retval == 0)
 278     memif_connect (vm, mif);
 279   else
 280     memif_disconnect (vm, mif);
 281
 282   return 0;
 283 }
 284
 285 static clib_error_t *
 286 memif_conn_fd_read_ready (unix_file_t * uf)
 287 {
 288   memif_main_t *mm = &memif_main;
 289   vlib_main_t *vm = vlib_get_main ();
 290   memif_if_t *mif = 0;
 291   memif_pending_conn_t *pending_conn = 0;
 292   int fd_array[2] = { -1, -1 };
 293   char ctl[CMSG_SPACE (sizeof (fd_array)) +
 294            CMSG_SPACE (sizeof (struct ucred))] = { 0 };
 295   struct msghdr mh = { 0 };
 296   struct iovec iov[1];
 297   struct ucred *cr = 0;
 298   memif_msg_t msg = { 0 };
 299   struct cmsghdr *cmsg;
 300   ssize_t size;
 301   static clib_error_t *error = 0;
 302
 303   iov[0].iov_base = (void *) &msg;
 304   iov[0].iov_len = sizeof (memif_msg_t);
 305   mh.msg_iov = iov;
 306   mh.msg_iovlen = 1;
 307   mh.msg_control = ctl;
 308   mh.msg_controllen = sizeof (ctl);
 309
 310   /* grab the appropriate context */
 311   if (uf->private_data & 1)
 312     pending_conn = vec_elt_at_index (mm->pending_conns,
 313                                      uf->private_data >> 1);
 314   else
 315     mif = vec_elt_at_index (mm->interfaces, uf->private_data >> 1);
 316
 317   /* receive the incoming message */
 318   size = recvmsg (uf->file_descriptor, &mh, 0);
 319   if (size != sizeof (memif_msg_t))
 320     {
 321       if (size != 0)
 322         {
 323           DEBUG_UNIX_LOG ("Malformed message received on fd %d",
 324                           uf->file_descriptor);
 325           error = clib_error_return_unix (0, "recvmsg fd %d",
 326                                           uf->file_descriptor);
 327         }
 328       goto disconnect;
 329     }
 330
 331   /* check version of the sender's memif plugin */
 332   if (msg.version != MEMIF_VERSION)
 333     {
 334       DEBUG_LOG ("Memif version mismatch");
 335       goto disconnect;
 336     }
 337
 338   /* process the message based on its type */
 339   switch (msg.type)
 340     {
 341     case MEMIF_MSG_TYPE_CONNECT_REQ:
 342       if (pending_conn == 0)
 343         {
 344           DEBUG_LOG ("Received unexpected connection request");
 345           return 0;
 346         }
 347
 348       /* Read anciliary data */
 349       cmsg = CMSG_FIRSTHDR (&mh);
 350       while (cmsg)
 351         {
 352           if (cmsg->cmsg_level == SOL_SOCKET
 353               && cmsg->cmsg_type == SCM_CREDENTIALS)
 354             {
 355               cr = (struct ucred *) CMSG_DATA (cmsg);
 356             }
 357           else if (cmsg->cmsg_level == SOL_SOCKET
 358                    && cmsg->cmsg_type == SCM_RIGHTS)
 359             {
 360               clib_memcpy (fd_array, CMSG_DATA (cmsg), sizeof (fd_array));
 361             }
 362           cmsg = CMSG_NXTHDR (&mh, cmsg);
 363         }
 364
 365       return memif_process_connect_req (pending_conn, &msg, cr,
 366                                         fd_array[0], fd_array[1]);
 367
 368     case MEMIF_MSG_TYPE_CONNECT_RESP:
 369       if (mif == 0)
 370         {
 371           DEBUG_LOG ("Received unexpected connection response");
 372           return 0;
 373         }
 374       return memif_process_connect_resp (mif, &msg);
 375
 376     case MEMIF_MSG_TYPE_DISCONNECT:
 377       goto disconnect;
 378
 379     default:
 380       DEBUG_LOG ("Received unknown message type");
 381       goto disconnect;
 382     }
 383
 384   return 0;
 385
 386 disconnect:
 387   if (pending_conn)
 388     memif_remove_pending_conn (pending_conn);
 389   else
 390     memif_disconnect (vm, mif);
 391   return error;
 392 }
 393
 394 static clib_error_t *
 395 memif_int_fd_read_ready (unix_file_t * uf)
 396 {
 397   memif_main_t *mm = &memif_main;
 398   vlib_main_t *vm = vlib_get_main ();
 399   memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data);
 400   u8 b;
 401   ssize_t size;
 402
 403   size = read (uf->file_descriptor, &b, sizeof (b));
 404   if (0 == size)
 405     {
 406       /* interrupt line was disconnected */
 407       unix_file_del (&unix_main,
 408                      unix_main.file_pool + mif->interrupt_line.index);
 409       mif->interrupt_line.index = ~0;
 410       mif->interrupt_line.fd = -1;
 411     }
 412   vlib_node_set_interrupt_pending (vm, memif_input_node.index);
 413   return 0;
 414 }
 415
 416 static clib_error_t *
 417 memif_conn_fd_accept_ready (unix_file_t * uf)
 418 {
 419   memif_main_t *mm = &memif_main;
 420   memif_listener_t *listener = 0;
 421   memif_pending_conn_t *pending_conn = 0;
 422   int addr_len;
 423   struct sockaddr_un client;
 424   int conn_fd;
 425   unix_file_t template = { 0 };
 426
 427   listener = pool_elt_at_index (mm->listeners, uf->private_data);
 428
 429   addr_len = sizeof (client);
 430   conn_fd = accept (uf->file_descriptor,
 431                     (struct sockaddr *) &client, (socklen_t *) & addr_len);
 432
 433   if (conn_fd < 0)
 434     return clib_error_return_unix (0, "accept fd %d", uf->file_descriptor);
 435
 436   pool_get (mm->pending_conns, pending_conn);
 437   pending_conn->index = pending_conn - mm->pending_conns;
 438   pending_conn->listener_index = listener->index;
 439   pending_conn->connection.fd = conn_fd;
 440
 441   template.read_function = memif_conn_fd_read_ready;
 442   template.file_descriptor = conn_fd;
 443   template.private_data = (pending_conn->index << 1) | 1;
 444   pending_conn->connection.index = unix_file_add (&unix_main, &template);
 445
 446   return 0;
 447 }
 448
 449 static void
 450 memif_connect_master (vlib_main_t * vm, memif_if_t * mif)
 451 {
 452   memif_msg_t msg;
 453   struct msghdr mh = { 0 };
 454   struct iovec iov[1];
 455   struct cmsghdr *cmsg;
 456   int mfd = -1;
 457   int rv;
 458   int fd_array[2] = { -1, -1 };
 459   char ctl[CMSG_SPACE (sizeof (fd_array))];
 460   memif_ring_t *ring = NULL;
 461   int i, j;
 462   void *shm = 0;
 463   u64 buffer_offset;
 464   unix_file_t template = { 0 };
 465
 466   msg.version = MEMIF_VERSION;
 467   msg.type = MEMIF_MSG_TYPE_CONNECT_REQ;
 468   msg.key = mif->key;
 469   msg.log2_ring_size = mif->log2_ring_size;
 470   msg.num_s2m_rings = mif->num_s2m_rings;
 471   msg.num_m2s_rings = mif->num_m2s_rings;
 472   msg.buffer_size = mif->buffer_size;
 473
 474   buffer_offset = sizeof (memif_shm_t) +
 475     (mif->num_s2m_rings + mif->num_m2s_rings) *
 476     (sizeof (memif_ring_t) +
 477      sizeof (memif_desc_t) * (1 << mif->log2_ring_size));
 478
 479   msg.shared_mem_size = buffer_offset +
 480     mif->buffer_size * (1 << mif->log2_ring_size) * (mif->num_s2m_rings +
 481                                                      mif->num_m2s_rings);
 482
 483   if ((mfd = memfd_create ("shared mem", MFD_ALLOW_SEALING)) == -1)
 484     {
 485       DEBUG_LOG ("Failed to create anonymous file");
 486       goto error;
 487     }
 488
 489   if ((fcntl (mfd, F_ADD_SEALS, F_SEAL_SHRINK)) == -1)
 490     {
 491       DEBUG_UNIX_LOG ("Failed to seal an anonymous file off from truncating");
 492       goto error;
 493     }
 494
 495   if ((ftruncate (mfd, msg.shared_mem_size)) == -1)
 496     {
 497       DEBUG_UNIX_LOG ("Failed to extend the size of an anonymous file");
 498       goto error;
 499     }
 500
 501   if ((shm = mmap (NULL, msg.shared_mem_size, PROT_READ | PROT_WRITE,
 502                    MAP_SHARED, mfd, 0)) == MAP_FAILED)
 503     {
 504       DEBUG_UNIX_LOG ("Failed to map anonymous file into memory");
 505       goto error;
 506     }
 507
 508   vec_add1 (mif->regions, shm);
 509   ((memif_shm_t *) mif->regions[0])->cookie = 0xdeadbeef;
 510
 511   for (i = 0; i < mif->num_s2m_rings; i++)
 512     {
 513       ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
 514       ring->head = ring->tail = 0;
 515       for (j = 0; j < (1 << mif->log2_ring_size); j++)
 516         {
 517           u16 slot = i * (1 << mif->log2_ring_size) + j;
 518           ring->desc[j].region = 0;
 519           ring->desc[j].offset =
 520             buffer_offset + (u32) (slot * mif->buffer_size);
 521           ring->desc[j].buffer_length = mif->buffer_size;
 522         }
 523     }
 524   for (i = 0; i < mif->num_m2s_rings; i++)
 525     {
 526       ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
 527       ring->head = ring->tail = 0;
 528       for (j = 0; j < (1 << mif->log2_ring_size); j++)
 529         {
 530           u16 slot =
 531             (i + mif->num_s2m_rings) * (1 << mif->log2_ring_size) + j;
 532           ring->desc[j].region = 0;
 533           ring->desc[j].offset =
 534             buffer_offset + (u32) (slot * mif->buffer_size);
 535           ring->desc[j].buffer_length = mif->buffer_size;
 536         }
 537     }
 538
 539   iov[0].iov_base = (void *) &msg;
 540   iov[0].iov_len = sizeof (memif_msg_t);
 541   mh.msg_iov = iov;
 542   mh.msg_iovlen = 1;
 543
 544   /* create interrupt socket */
 545   if (socketpair (AF_UNIX, SOCK_STREAM, 0, fd_array) < 0)
 546     {
 547       DEBUG_UNIX_LOG ("Failed to create a pair of connected sockets");
 548       goto error;
 549     }
 550
 551   mif->interrupt_line.fd = fd_array[0];
 552   template.read_function = memif_int_fd_read_ready;
 553   template.file_descriptor = mif->interrupt_line.fd;
 554   template.private_data = mif->if_index;
 555   mif->interrupt_line.index = unix_file_add (&unix_main, &template);
 556
 557   memset (&ctl, 0, sizeof (ctl));
 558   mh.msg_control = ctl;
 559   mh.msg_controllen = sizeof (ctl);
 560   cmsg = CMSG_FIRSTHDR (&mh);
 561   cmsg->cmsg_len = CMSG_LEN (sizeof (fd_array));
 562   cmsg->cmsg_level = SOL_SOCKET;
 563   cmsg->cmsg_type = SCM_RIGHTS;
 564   fd_array[0] = mfd;
 565   clib_memcpy (CMSG_DATA (cmsg), fd_array, sizeof (fd_array));
 566
 567   mif->flags |= MEMIF_IF_FLAG_CONNECTING;
 568   rv = sendmsg (mif->connection.fd, &mh, 0);
 569   if (rv < 0)
 570     {
 571       DEBUG_UNIX_LOG ("Failed to send memif connection request");
 572       goto error;
 573     }
 574
 575   /* No need to keep the descriptor open,
 576    * mmap creates an extra reference to the underlying file */
 577   close (mfd);
 578   mfd = -1;
 579   /* This FD is given to peer, so we can close it */
 580   close (fd_array[1]);
 581   fd_array[1] = -1;
 582   return;
 583
 584 error:
 585   if (mfd > -1)
 586     close (mfd);
 587   if (fd_array[1] > -1)
 588     close (fd_array[1]);
 589   memif_disconnect (vm, mif);
 590 }
 591
 592 static uword
 593 memif_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
 594 {
 595   memif_main_t *mm = &memif_main;
 596   memif_if_t *mif;
 597   struct sockaddr_un sun;
 598   int sockfd;
 599   uword *event_data = 0, event_type;
 600   unix_file_t template = { 0 };
 601   u8 enabled = 0;
 602   f64 start_time, last_run_duration = 0, now;
 603
 604   sockfd = socket (AF_UNIX, SOCK_STREAM, 0);
 605   if (sockfd < 0)
 606     {
 607       DEBUG_UNIX_LOG ("socket AF_UNIX");
 608       return 0;
 609     }
 610   sun.sun_family = AF_UNIX;
 611   template.read_function = memif_conn_fd_read_ready;
 612
 613   while (1)
 614     {
 615       if (enabled)
 616         vlib_process_wait_for_event_or_clock (vm,
 617                                               (f64) 3 - last_run_duration);
 618       else
 619         vlib_process_wait_for_event (vm);
 620
 621       event_type = vlib_process_get_events (vm, &event_data);
 622       vec_reset_length (event_data);
 623
 624       switch (event_type)
 625         {
 626         case ~0:
 627           break;
 628         case MEMIF_PROCESS_EVENT_START:
 629           enabled = 1;
 630           break;
 631         case MEMIF_PROCESS_EVENT_STOP:
 632           enabled = 0;
 633           continue;
 634         default:
 635           ASSERT (0);
 636         }
 637
 638       last_run_duration = start_time = vlib_time_now (vm);
 639       /* *INDENT-OFF* */
 640       pool_foreach (mif, mm->interfaces,
 641         ({
 642           /* Allow no more than 10us without a pause */
 643           now = vlib_time_now (vm);
 644           if (now > start_time + 10e-6)
 645             {
 646               vlib_process_suspend (vm, 100e-6);        /* suspend for 100 us */
 647               start_time = vlib_time_now (vm);
 648             }
 649
 650           if ((mif->flags & MEMIF_IF_FLAG_ADMIN_UP) == 0)
 651             continue;
 652
 653           if (mif->flags & MEMIF_IF_FLAG_CONNECTING)
 654             continue;
 655
 656           if (mif->flags & MEMIF_IF_FLAG_CONNECTED)
 657             continue;
 658
 659           if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
 660             {
 661               strncpy (sun.sun_path, (char *) mif->socket_filename,
 662                        sizeof (sun.sun_path) - 1);
 663
 664               if (connect
 665                   (sockfd, (struct sockaddr *) &sun,
 666                    sizeof (struct sockaddr_un)) == 0)
 667                 {
 668                   mif->connection.fd = sockfd;
 669                   template.file_descriptor = sockfd;
 670                   template.private_data = mif->if_index << 1;
 671                   mif->connection.index = unix_file_add (&unix_main, &template);
 672                   memif_connect_master (vm, mif);
 673
 674                   /* grab another fd */
 675                   sockfd = socket (AF_UNIX, SOCK_STREAM, 0);
 676                   if (sockfd < 0)
 677                     {
 678                       DEBUG_UNIX_LOG ("socket AF_UNIX");
 679                       return 0;
 680                     }
 681                 }
 682             }
 683         }));
 684       /* *INDENT-ON* */
 685       last_run_duration = vlib_time_now (vm) - last_run_duration;
 686     }
 687   return 0;
 688 }
 689
 690 /* *INDENT-OFF* */
 691 VLIB_REGISTER_NODE (memif_process_node,static) = {
 692   .function = memif_process,
 693   .type = VLIB_NODE_TYPE_PROCESS,
 694   .name = "memif-process",
 695 };
 696 /* *INDENT-ON* */
 697
 698 static void
 699 memif_close_if (memif_main_t * mm, memif_if_t * mif)
 700 {
 701   vlib_main_t *vm = vlib_get_main ();
 702   memif_listener_t *listener = 0;
 703   memif_pending_conn_t *pending_conn = 0;
 704
 705   memif_disconnect (vm, mif);
 706
 707   if (mif->listener_index != (uword) ~ 0)
 708     {
 709       listener = pool_elt_at_index (mm->listeners, mif->listener_index);
 710       if (--listener->usage_counter == 0)
 711         {
 712           /* not used anymore -> remove the socket and pending connections */
 713
 714           /* *INDENT-OFF* */
 715           pool_foreach (pending_conn, mm->pending_conns,
 716             ({
 717                if (pending_conn->listener_index == mif->listener_index)
 718                  {
 719                    memif_remove_pending_conn (pending_conn);
 720                  }
 721              }));
 722           /* *INDENT-ON* */
 723
 724           unix_file_del (&unix_main,
 725                          unix_main.file_pool + listener->socket.index);
 726           pool_put (mm->listeners, listener);
 727           unlink ((char *) mif->socket_filename);
 728         }
 729     }
 730
 731   clib_spinlock_free (&mif->lockp);
 732
 733   mhash_unset (&mm->if_index_by_key, &mif->key, &mif->if_index);
 734   vec_free (mif->socket_filename);
 735   vec_free (mif->ring_data);
 736
 737   memset (mif, 0, sizeof (*mif));
 738   pool_put (mm->interfaces, mif);
 739 }
 740
 741 int
 742 memif_worker_thread_enable ()
 743 {
 744   /* if worker threads are enabled, switch to polling mode */
 745   /* *INDENT-OFF* */
 746   foreach_vlib_main ((
 747                        {
 748                        vlib_node_set_state (this_vlib_main,
 749                                             memif_input_node.index,
 750                                             VLIB_NODE_STATE_POLLING);
 751                        }));
 752   /* *INDENT-ON* */
 753   return 0;
 754 }
 755
 756 int
 757 memif_worker_thread_disable ()
 758 {
 759   /* *INDENT-OFF* */
 760   foreach_vlib_main ((
 761                        {
 762                        vlib_node_set_state (this_vlib_main,
 763                                             memif_input_node.index,
 764                                             VLIB_NODE_STATE_INTERRUPT);
 765                        }));
 766   /* *INDENT-ON* */
 767   return 0;
 768 }
 769
 770 int
 771 memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args)
 772 {
 773   memif_main_t *mm = &memif_main;
 774   vlib_thread_main_t *tm = vlib_get_thread_main ();
 775   vnet_main_t *vnm = vnet_get_main ();
 776   memif_if_t *mif = 0;
 777   vnet_sw_interface_t *sw;
 778   clib_error_t *error = 0;
 779   int ret = 0;
 780   uword *p;
 781
 782   p = mhash_get (&mm->if_index_by_key, &args->key);
 783   if (p)
 784     return VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
 785
 786   pool_get (mm->interfaces, mif);
 787   memset (mif, 0, sizeof (*mif));
 788   mif->key = args->key;
 789   mif->if_index = mif - mm->interfaces;
 790   mif->sw_if_index = mif->hw_if_index = mif->per_interface_next_index = ~0;
 791   mif->listener_index = ~0;
 792   mif->connection.index = mif->interrupt_line.index = ~0;
 793   mif->connection.fd = mif->interrupt_line.fd = -1;
 794
 795   if (tm->n_vlib_mains > 1)
 796     clib_spinlock_init (&mif->lockp);
 797
 798   if (!args->hw_addr_set)
 799     {
 800       f64 now = vlib_time_now (vm);
 801       u32 rnd;
 802       rnd = (u32) (now * 1e6);
 803       rnd = random_u32 (&rnd);
 804
 805       memcpy (args->hw_addr + 2, &rnd, sizeof (rnd));
 806       args->hw_addr[0] = 2;
 807       args->hw_addr[1] = 0xfe;
 808     }
 809
 810   error = ethernet_register_interface (vnm, memif_device_class.index,
 811                                        mif->if_index, args->hw_addr,
 812                                        &mif->hw_if_index,
 813                                        memif_eth_flag_change);
 814
 815   if (error)
 816     {
 817       clib_error_report (error);
 818       ret = VNET_API_ERROR_SYSCALL_ERROR_1;
 819       goto error;
 820     }
 821
 822   sw = vnet_get_hw_sw_interface (vnm, mif->hw_if_index);
 823   mif->sw_if_index = sw->sw_if_index;
 824
 825   mif->log2_ring_size = args->log2_ring_size;
 826   mif->buffer_size = args->buffer_size;
 827
 828   /* TODO: make configurable */
 829   mif->num_s2m_rings = 1;
 830   mif->num_m2s_rings = 1;
 831
 832   mhash_set_mem (&mm->if_index_by_key, &args->key, &mif->if_index, 0);
 833
 834   if (args->socket_filename != 0)
 835     mif->socket_filename = args->socket_filename;
 836   else
 837     mif->socket_filename = vec_dup (mm->default_socket_filename);
 838
 839   args->sw_if_index = mif->sw_if_index;
 840
 841   if (args->is_master)
 842     {
 843       struct sockaddr_un un = { 0 };
 844       struct stat file_stat;
 845       int on = 1;
 846       memif_listener_t *listener = 0;
 847
 848       if (stat ((char *) mif->socket_filename, &file_stat) == 0)
 849         {
 850           if (!S_ISSOCK (file_stat.st_mode))
 851             {
 852               errno = ENOTSOCK;
 853               ret = VNET_API_ERROR_SYSCALL_ERROR_2;
 854               goto error;
 855             }
 856           /* *INDENT-OFF* */
 857           pool_foreach (listener, mm->listeners,
 858             ({
 859                if (listener->sock_dev == file_stat.st_dev &&
 860                    listener->sock_ino == file_stat.st_ino)
 861                  {
 862                    /* attach memif to the existing listener */
 863                    mif->listener_index = listener->index;
 864                    ++listener->usage_counter;
 865                    goto signal;
 866                  }
 867              }));
 868           /* *INDENT-ON* */
 869           unlink ((char *) mif->socket_filename);
 870         }
 871
 872       pool_get (mm->listeners, listener);
 873       memset (listener, 0, sizeof (*listener));
 874       listener->socket.fd = -1;
 875       listener->socket.index = ~0;
 876       listener->index = listener - mm->listeners;
 877       listener->usage_counter = 1;
 878
 879       if ((listener->socket.fd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
 880         {
 881           ret = VNET_API_ERROR_SYSCALL_ERROR_3;
 882           goto error;
 883         }
 884
 885       un.sun_family = AF_UNIX;
 886       strncpy ((char *) un.sun_path, (char *) mif->socket_filename,
 887                sizeof (un.sun_path) - 1);
 888
 889       if (setsockopt (listener->socket.fd, SOL_SOCKET, SO_PASSCRED,
 890                       &on, sizeof (on)) < 0)
 891         {
 892           ret = VNET_API_ERROR_SYSCALL_ERROR_4;
 893           goto error;
 894         }
 895       if (bind (listener->socket.fd, (struct sockaddr *) &un,
 896                 sizeof (un)) == -1)
 897         {
 898           ret = VNET_API_ERROR_SYSCALL_ERROR_5;
 899           goto error;
 900         }
 901       if (listen (listener->socket.fd, 1) == -1)
 902         {
 903           ret = VNET_API_ERROR_SYSCALL_ERROR_6;
 904           goto error;
 905         }
 906
 907       if (stat ((char *) mif->socket_filename, &file_stat) == -1)
 908         {
 909           ret = VNET_API_ERROR_SYSCALL_ERROR_7;
 910           goto error;
 911         }
 912
 913       listener->sock_dev = file_stat.st_dev;
 914       listener->sock_ino = file_stat.st_ino;
 915
 916       unix_file_t template = { 0 };
 917       template.read_function = memif_conn_fd_accept_ready;
 918       template.file_descriptor = listener->socket.fd;
 919       template.private_data = listener->index;
 920       listener->socket.index = unix_file_add (&unix_main, &template);
 921
 922       mif->listener_index = listener->index;
 923     }
 924   else
 925     {
 926       mif->flags |= MEMIF_IF_FLAG_IS_SLAVE;
 927     }
 928
 929 #if 0
 930   /* use configured or generate random MAC address */
 931   if (!args->hw_addr_set &&
 932       tm->n_vlib_mains > 1 && pool_elts (mm->interfaces) == 1)
 933     memif_worker_thread_enable ();
 934 #endif
 935
 936 signal:
 937   if (pool_elts (mm->interfaces) == 1)
 938     {
 939       vlib_process_signal_event (vm, memif_process_node.index,
 940                                  MEMIF_PROCESS_EVENT_START, 0);
 941     }
 942   return 0;
 943
 944 error:
 945   if (mif->hw_if_index != ~0)
 946     {
 947       ethernet_delete_interface (vnm, mif->hw_if_index);
 948       mif->hw_if_index = ~0;
 949     }
 950   memif_close_if (mm, mif);
 951   return ret;
 952 }
 953
 954 int
 955 memif_delete_if (vlib_main_t * vm, u64 key)
 956 {
 957   vnet_main_t *vnm = vnet_get_main ();
 958   memif_main_t *mm = &memif_main;
 959   memif_if_t *mif;
 960   uword *p;
 961
 962   p = mhash_get (&mm->if_index_by_key, &key);
 963   if (p == NULL)
 964     {
 965       clib_warning ("Memory interface with key 0x%" PRIx64 " does not exist",
 966                     key);
 967       return VNET_API_ERROR_SYSCALL_ERROR_1;
 968     }
 969   mif = pool_elt_at_index (mm->interfaces, p[0]);
 970   mif->flags |= MEMIF_IF_FLAG_DELETING;
 971
 972   /* bring down the interface */
 973   vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
 974   vnet_sw_interface_set_flags (vnm, mif->sw_if_index, 0);
 975
 976   /* remove the interface */
 977   ethernet_delete_interface (vnm, mif->hw_if_index);
 978   mif->hw_if_index = ~0;
 979   memif_close_if (mm, mif);
 980
 981   if (pool_elts (mm->interfaces) == 0)
 982     {
 983       vlib_process_signal_event (vm, memif_process_node.index,
 984                                  MEMIF_PROCESS_EVENT_STOP, 0);
 985     }
 986
 987 #if 0
 988   if (tm->n_vlib_mains > 1 && pool_elts (mm->interfaces) == 0)
 989     memif_worker_thread_disable ();
 990 #endif
 991
 992   return 0;
 993 }
 994
 995 static clib_error_t *
 996 memif_init (vlib_main_t * vm)
 997 {
 998   memif_main_t *mm = &memif_main;
 999   vlib_thread_main_t *tm = vlib_get_thread_main ();
1000   vlib_thread_registration_t *tr;
1001   uword *p;
1002
1003   memset (mm, 0, sizeof (memif_main_t));
1004
1005   mm->input_cpu_first_index = 0;
1006   mm->input_cpu_count = 1;
1007
1008   /* initialize binary API */
1009   memif_plugin_api_hookup (vm);
1010
1011   /* find out which cpus will be used for input */
1012   p = hash_get_mem (tm->thread_registrations_by_name, "workers");
1013   tr = p ? (vlib_thread_registration_t *) p[0] : 0;
1014
1015   if (tr && tr->count > 0)
1016     {
1017       mm->input_cpu_first_index = tr->first_index;
1018       mm->input_cpu_count = tr->count;
1019     }
1020
1021   mhash_init (&mm->if_index_by_key, sizeof (uword), sizeof (u64));
1022
1023   vec_validate_aligned (mm->rx_buffers, tm->n_vlib_mains - 1,
1024                         CLIB_CACHE_LINE_BYTES);
1025
1026   /* set default socket filename */
1027   vec_validate (mm->default_socket_filename,
1028                 strlen (MEMIF_DEFAULT_SOCKET_FILENAME));
1029   strncpy ((char *) mm->default_socket_filename,
1030            MEMIF_DEFAULT_SOCKET_FILENAME,
1031            vec_len (mm->default_socket_filename) - 1);
1032
1033   return 0;
1034 }
1035
1036 VLIB_INIT_FUNCTION (memif_init);
1037
1038 /* *INDENT-OFF* */
1039 VLIB_PLUGIN_REGISTER () = {
1040     .version = VPP_BUILD_VER,
1041     .description = "Packet Memory Interface (experimetal)",
1042 };
1043 /* *INDENT-ON* */
1044
1045 /*
1046  * fd.io coding-style-patch-verification: ON
1047  *
1048  * Local Variables:
1049  * eval: (c-set-style "gnu")
1050  * End:
1051  */