src/plugins/memif/memif.c

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2017 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
  19 #define _GNU_SOURCE
  20 #include <stdint.h>
  21 #include <net/if.h>
  22 #include <sys/types.h>
  23 #include <fcntl.h>
  24 #include <sys/ioctl.h>
  25 #include <sys/socket.h>
  26 #include <sys/un.h>
  27 #include <sys/uio.h>
  28 #include <sys/mman.h>
  29 #include <sys/prctl.h>
  30 #include <sys/eventfd.h>
  31 #include <inttypes.h>
  32 #include <limits.h>
  33
  34 #include <vlib/vlib.h>
  35 #include <vlib/unix/unix.h>
  36 #include <vppinfra/linux/syscall.h>
  37 #include <vnet/plugin/plugin.h>
  38 #include <vnet/ethernet/ethernet.h>
  39 #include <vpp/app/version.h>
  40 #include <memif/memif.h>
  41 #include <memif/private.h>
  42
  43 memif_main_t memif_main;
  44
  45 static u32
  46 memif_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi, u32 flags)
  47 {
  48   /* nothing for now */
  49   return 0;
  50 }
  51
  52 static void
  53 memif_queue_intfd_close (memif_queue_t * mq)
  54 {
  55   if (mq->int_clib_file_index != ~0)
  56     {
  57       memif_file_del_by_index (mq->int_clib_file_index);
  58       mq->int_clib_file_index = ~0;
  59       mq->int_fd = -1;
  60     }
  61   else if (mq->int_fd > -1)
  62     {
  63       close (mq->int_fd);
  64       mq->int_fd = -1;
  65     }
  66 }
  67
  68 void
  69 memif_disconnect (memif_if_t * mif, clib_error_t * err)
  70 {
  71   memif_main_t *mm = &memif_main;
  72   vnet_main_t *vnm = vnet_get_main ();
  73   memif_region_t *mr;
  74   memif_queue_t *mq;
  75   int i;
  76
  77   if (mif == 0)
  78     return;
  79
  80   DBG ("disconnect %u (%v)", mif->dev_instance, err ? err->what : 0);
  81
  82   if (err)
  83     {
  84       clib_error_t *e = 0;
  85       mif->local_disc_string = vec_dup (err->what);
  86       if (mif->sock && clib_socket_is_connected (mif->sock))
  87         e = memif_msg_send_disconnect (mif, err);
  88       clib_error_free (e);
  89     }
  90
  91   /* set interface down */
  92   mif->flags &= ~(MEMIF_IF_FLAG_CONNECTED | MEMIF_IF_FLAG_CONNECTING);
  93   if (mif->hw_if_index != ~0)
  94     vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
  95
  96   /* close connection socket */
  97   if (mif->sock && mif->sock->fd)
  98     {
  99       memif_socket_file_t *msf = vec_elt_at_index (mm->socket_files,
 100                                                    mif->socket_file_index);
 101       hash_unset (msf->dev_instance_by_fd, mif->sock->fd);
 102       memif_socket_close (&mif->sock);
 103     }
 104   else if (mif->sock)
 105     {
 106       clib_error_t *err;
 107       err = clib_socket_close (mif->sock);
 108       if (err)
 109         clib_error_report (err);
 110       clib_mem_free (mif->sock);
 111     }
 112
 113   vec_foreach_index (i, mif->rx_queues)
 114   {
 115     mq = vec_elt_at_index (mif->rx_queues, i);
 116     if (mq->ring)
 117       {
 118         int rv;
 119         rv = vnet_hw_interface_unassign_rx_thread (vnm, mif->hw_if_index, i);
 120         if (rv)
 121           DBG ("Warning: unable to unassign interface %d, "
 122                "queue %d: rc=%d", mif->hw_if_index, i, rv);
 123         mq->ring = 0;
 124       }
 125   }
 126
 127   /* free tx and rx queues */
 128   vec_foreach (mq, mif->rx_queues) memif_queue_intfd_close (mq);
 129   vec_free (mif->rx_queues);
 130
 131   vec_foreach (mq, mif->tx_queues) memif_queue_intfd_close (mq);
 132   vec_free (mif->tx_queues);
 133
 134   /* free memory regions */
 135   vec_foreach (mr, mif->regions)
 136   {
 137     int rv;
 138     if ((rv = munmap (mr->shm, mr->region_size)))
 139       clib_warning ("munmap failed, rv = %d", rv);
 140     if (mr->fd > -1)
 141       close (mr->fd);
 142   }
 143   vec_free (mif->regions);
 144   vec_free (mif->remote_name);
 145   vec_free (mif->remote_if_name);
 146   clib_fifo_free (mif->msg_queue);
 147 }
 148
 149 static clib_error_t *
 150 memif_int_fd_read_ready (clib_file_t * uf)
 151 {
 152   memif_main_t *mm = &memif_main;
 153   vnet_main_t *vnm = vnet_get_main ();
 154   u16 qid = uf->private_data & 0xFFFF;
 155   memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data >> 16);
 156   memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, qid);
 157   u64 b;
 158   ssize_t size;
 159
 160   size = read (uf->file_descriptor, &b, sizeof (b));
 161   if (size < 0)
 162     {
 163       DBG_UNIX_LOG ("Failed to read from socket");
 164       return 0;
 165     }
 166
 167   vnet_device_input_set_interrupt_pending (vnm, mif->hw_if_index, qid);
 168   mq->int_count++;
 169
 170   return 0;
 171 }
 172
 173
 174 clib_error_t *
 175 memif_connect (memif_if_t * mif)
 176 {
 177   vnet_main_t *vnm = vnet_get_main ();
 178   clib_file_t template = { 0 };
 179   memif_region_t *mr;
 180   int i;
 181
 182   DBG ("connect %u", mif->dev_instance);
 183
 184   vec_free (mif->local_disc_string);
 185   vec_free (mif->remote_disc_string);
 186
 187   vec_foreach (mr, mif->regions)
 188   {
 189     if (mr->shm)
 190       continue;
 191
 192     if (mr->fd < 0)
 193       clib_error_return (0, "no memory region fd");
 194
 195     if ((mr->shm = mmap (NULL, mr->region_size, PROT_READ | PROT_WRITE,
 196                          MAP_SHARED, mr->fd, 0)) == MAP_FAILED)
 197       return clib_error_return_unix (0, "mmap");
 198   }
 199
 200   template.read_function = memif_int_fd_read_ready;
 201
 202   vec_foreach_index (i, mif->tx_queues)
 203   {
 204     memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
 205
 206     mq->ring = mif->regions[mq->region].shm + mq->offset;
 207     if (mq->ring->cookie != MEMIF_COOKIE)
 208       return clib_error_return (0, "wrong cookie on tx ring %u", i);
 209   }
 210
 211   vec_foreach_index (i, mif->rx_queues)
 212   {
 213     memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
 214     int rv;
 215
 216     mq->ring = mif->regions[mq->region].shm + mq->offset;
 217     if (mq->ring->cookie != MEMIF_COOKIE)
 218       return clib_error_return (0, "wrong cookie on tx ring %u", i);
 219
 220     if (mq->int_fd > -1)
 221       {
 222         template.file_descriptor = mq->int_fd;
 223         template.private_data = (mif->dev_instance << 16) | (i & 0xFFFF);
 224         template.description = format (0, "%U rx %u int",
 225                                        format_memif_device_name,
 226                                        mif->dev_instance, i);
 227         memif_file_add (&mq->int_clib_file_index, &template);
 228       }
 229     vnet_hw_interface_assign_rx_thread (vnm, mif->hw_if_index, i, ~0);
 230     rv = vnet_hw_interface_set_rx_mode (vnm, mif->hw_if_index, i,
 231                                         VNET_HW_INTERFACE_RX_MODE_DEFAULT);
 232     if (rv)
 233       clib_warning
 234         ("Warning: unable to set rx mode for interface %d queue %d: "
 235          "rc=%d", mif->hw_if_index, i, rv);
 236     else
 237       {
 238         vnet_hw_interface_rx_mode rxmode;
 239         vnet_hw_interface_get_rx_mode (vnm, mif->hw_if_index, i, &rxmode);
 240
 241         if (rxmode == VNET_HW_INTERFACE_RX_MODE_POLLING)
 242           mq->ring->flags |= MEMIF_RING_FLAG_MASK_INT;
 243       }
 244   }
 245
 246   mif->flags &= ~MEMIF_IF_FLAG_CONNECTING;
 247   mif->flags |= MEMIF_IF_FLAG_CONNECTED;
 248
 249   vnet_hw_interface_set_flags (vnm, mif->hw_if_index,
 250                                VNET_HW_INTERFACE_FLAG_LINK_UP);
 251   return 0;
 252 }
 253
 254 static_always_inline memif_ring_t *
 255 memif_get_ring (memif_if_t * mif, memif_ring_type_t type, u16 ring_num)
 256 {
 257   if (vec_len (mif->regions) == 0)
 258     return NULL;
 259   void *p = mif->regions[0].shm;
 260   int ring_size =
 261     sizeof (memif_ring_t) +
 262     sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size);
 263   p += (ring_num + type * mif->run.num_s2m_rings) * ring_size;
 264
 265   return (memif_ring_t *) p;
 266 }
 267
 268 clib_error_t *
 269 memif_init_regions_and_queues (memif_if_t * mif)
 270 {
 271   memif_ring_t *ring = NULL;
 272   int i, j;
 273   u64 buffer_offset;
 274   memif_region_t *r;
 275   clib_mem_vm_alloc_t alloc = { 0 };
 276   clib_error_t *err;
 277
 278   vec_validate_aligned (mif->regions, 0, CLIB_CACHE_LINE_BYTES);
 279   r = vec_elt_at_index (mif->regions, 0);
 280
 281   buffer_offset = (mif->run.num_s2m_rings + mif->run.num_m2s_rings) *
 282     (sizeof (memif_ring_t) +
 283      sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size));
 284
 285   r->region_size = buffer_offset +
 286     mif->run.buffer_size * (1 << mif->run.log2_ring_size) *
 287     (mif->run.num_s2m_rings + mif->run.num_m2s_rings);
 288
 289   alloc.name = "memif region";
 290   alloc.size = r->region_size;
 291   alloc.flags = CLIB_MEM_VM_F_SHARED;
 292
 293   err = clib_mem_vm_ext_alloc (&alloc);
 294   if (err)
 295     return err;
 296
 297   r->fd = alloc.fd;
 298   r->shm = alloc.addr;
 299
 300   for (i = 0; i < mif->run.num_s2m_rings; i++)
 301     {
 302       ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
 303       ring->head = ring->tail = 0;
 304       ring->cookie = MEMIF_COOKIE;
 305       for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
 306         {
 307           u16 slot = i * (1 << mif->run.log2_ring_size) + j;
 308           ring->desc[j].region = 0;
 309           ring->desc[j].offset =
 310             buffer_offset + (u32) (slot * mif->run.buffer_size);
 311           ring->desc[j].buffer_length = mif->run.buffer_size;
 312         }
 313     }
 314   for (i = 0; i < mif->run.num_m2s_rings; i++)
 315     {
 316       ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
 317       ring->head = ring->tail = 0;
 318       ring->cookie = MEMIF_COOKIE;
 319       for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
 320         {
 321           u16 slot =
 322             (i + mif->run.num_s2m_rings) * (1 << mif->run.log2_ring_size) + j;
 323           ring->desc[j].region = 0;
 324           ring->desc[j].offset =
 325             buffer_offset + (u32) (slot * mif->run.buffer_size);
 326           ring->desc[j].buffer_length = mif->run.buffer_size;
 327         }
 328     }
 329
 330   ASSERT (mif->tx_queues == 0);
 331   vec_validate_aligned (mif->tx_queues, mif->run.num_s2m_rings - 1,
 332                         CLIB_CACHE_LINE_BYTES);
 333   vec_foreach_index (i, mif->tx_queues)
 334   {
 335     memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
 336     if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
 337       return clib_error_return_unix (0, "eventfd[tx queue %u]", i);
 338     mq->int_clib_file_index = ~0;
 339     mq->ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
 340     mq->log2_ring_size = mif->cfg.log2_ring_size;
 341     mq->region = 0;
 342     mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
 343     mq->last_head = 0;
 344   }
 345
 346   ASSERT (mif->rx_queues == 0);
 347   vec_validate_aligned (mif->rx_queues, mif->run.num_m2s_rings - 1,
 348                         CLIB_CACHE_LINE_BYTES);
 349   vec_foreach_index (i, mif->rx_queues)
 350   {
 351     memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
 352     if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
 353       return clib_error_return_unix (0, "eventfd[rx queue %u]", i);
 354     mq->int_clib_file_index = ~0;
 355     mq->ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
 356     mq->log2_ring_size = mif->cfg.log2_ring_size;
 357     mq->region = 0;
 358     mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
 359     mq->last_head = 0;
 360   }
 361
 362   return 0;
 363 }
 364
 365 static uword
 366 memif_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
 367 {
 368   memif_main_t *mm = &memif_main;
 369   memif_if_t *mif;
 370   clib_socket_t *sock;
 371   uword *event_data = 0, event_type;
 372   u8 enabled = 0;
 373   f64 start_time, last_run_duration = 0, now;
 374   clib_error_t *err;
 375
 376   sock = clib_mem_alloc (sizeof (clib_socket_t));
 377   memset (sock, 0, sizeof (clib_socket_t));
 378
 379   while (1)
 380     {
 381       if (enabled)
 382         vlib_process_wait_for_event_or_clock (vm, (f64) 3 -
 383                                               last_run_duration);
 384       else
 385         vlib_process_wait_for_event (vm);
 386
 387       event_type = vlib_process_get_events (vm, &event_data);
 388       vec_reset_length (event_data);
 389
 390       switch (event_type)
 391         {
 392         case ~0:
 393           break;
 394         case MEMIF_PROCESS_EVENT_START:
 395           enabled = 1;
 396           break;
 397         case MEMIF_PROCESS_EVENT_STOP:
 398           enabled = 0;
 399           continue;
 400         default:
 401           ASSERT (0);
 402         }
 403
 404       last_run_duration = start_time = vlib_time_now (vm);
 405       /* *INDENT-OFF* */
 406       pool_foreach (mif, mm->interfaces,
 407         ({
 408           memif_socket_file_t * msf = vec_elt_at_index (mm->socket_files, mif->socket_file_index);
 409           /* Allow no more than 10us without a pause */
 410           now = vlib_time_now (vm);
 411           if (now > start_time + 10e-6)
 412             {
 413               vlib_process_suspend (vm, 100e-6);        /* suspend for 100 us */
 414               start_time = vlib_time_now (vm);
 415             }
 416
 417           if ((mif->flags & MEMIF_IF_FLAG_ADMIN_UP) == 0)
 418             continue;
 419
 420           if (mif->flags & MEMIF_IF_FLAG_CONNECTING)
 421             continue;
 422
 423           if (mif->flags & MEMIF_IF_FLAG_CONNECTED)
 424             continue;
 425
 426           if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
 427             {
 428               memset (sock, 0, sizeof(clib_socket_t));
 429               sock->config = (char *) msf->filename;
 430               sock->flags = CLIB_SOCKET_F_IS_CLIENT| CLIB_SOCKET_F_SEQPACKET;
 431
 432               if ((err = clib_socket_init (sock)))
 433                 {
 434                   clib_error_free (err);
 435                 }
 436               else
 437                 {
 438                   clib_file_t t = { 0 };
 439
 440                   t.read_function = memif_slave_conn_fd_read_ready;
 441                   t.write_function = memif_slave_conn_fd_write_ready;
 442                   t.error_function = memif_slave_conn_fd_error;
 443                   t.file_descriptor = sock->fd;
 444                   t.private_data = mif->dev_instance;
 445                   memif_file_add (&sock->private_data, &t);
 446                   t.description = format (0, "%U ctl",
 447                                           format_memif_device_name,
 448                                           mif->dev_instance);
 449                   hash_set (msf->dev_instance_by_fd, sock->fd, mif->dev_instance);
 450
 451                   mif->flags |= MEMIF_IF_FLAG_CONNECTING;
 452                   mif->sock = sock;
 453                   sock = clib_mem_alloc (sizeof(clib_socket_t));
 454                 }
 455             }
 456         }));
 457       /* *INDENT-ON* */
 458       last_run_duration = vlib_time_now (vm) - last_run_duration;
 459     }
 460   return 0;
 461 }
 462
 463 /* *INDENT-OFF* */
 464 VLIB_REGISTER_NODE (memif_process_node,static) = {
 465   .function = memif_process,
 466   .type = VLIB_NODE_TYPE_PROCESS,
 467   .name = "memif-process",
 468 };
 469 /* *INDENT-ON* */
 470
 471
 472 static int
 473 memif_add_socket_file (u32 sock_id, u8 * socket_filename)
 474 {
 475   memif_main_t *mm = &memif_main;
 476   uword *p;
 477   memif_socket_file_t *msf;
 478
 479   p = hash_get (mm->socket_file_index_by_sock_id, sock_id);
 480   if (p)
 481     {
 482       msf = pool_elt_at_index (mm->socket_files, *p);
 483       if (strcmp ((char *) msf->filename, (char *) socket_filename) == 0)
 484         {
 485           /* Silently accept identical "add". */
 486           return 0;
 487         }
 488
 489       /* But don't allow a direct add of a different filename. */
 490       return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
 491     }
 492
 493   DBG ("creating socket file (uninitialized) %s", msf->filename);
 494
 495   pool_get (mm->socket_files, msf);
 496   memset (msf, 0, sizeof (memif_socket_file_t));
 497
 498   msf->filename = socket_filename;
 499   msf->socket_id = sock_id;
 500
 501   hash_set (mm->socket_file_index_by_sock_id, sock_id,
 502             msf - mm->socket_files);
 503
 504   return 0;
 505 }
 506
 507 static int
 508 memif_delete_socket_file (u32 sock_id)
 509 {
 510   memif_main_t *mm = &memif_main;
 511   uword *p;
 512   memif_socket_file_t *msf;
 513
 514   p = hash_get (mm->socket_file_index_by_sock_id, sock_id);
 515   if (!p)
 516     {
 517       /* Don't delete non-existent entries. */
 518       return VNET_API_ERROR_INVALID_ARGUMENT;
 519     }
 520
 521   msf = pool_elt_at_index (mm->socket_files, *p);
 522   if (msf->ref_cnt > 0)
 523     {
 524       return VNET_API_ERROR_UNEXPECTED_INTF_STATE;
 525     }
 526
 527   vec_free (msf->filename);
 528   pool_put (mm->socket_files, msf);
 529
 530   hash_unset (mm->socket_file_index_by_sock_id, sock_id);
 531
 532   return 0;
 533 }
 534
 535 int
 536 memif_socket_filename_add_del (u8 is_add, u32 sock_id, u8 * sock_filename)
 537 {
 538   if (sock_id == 0 || sock_id == ~0)
 539     {
 540       return VNET_API_ERROR_INVALID_ARGUMENT;
 541     }
 542
 543   if (is_add == 0)
 544     {
 545       return memif_delete_socket_file (sock_id);
 546     }
 547
 548   if (sock_filename == 0 || sock_filename[0] == 0)
 549     {
 550       return VNET_API_ERROR_INVALID_ARGUMENT;
 551     }
 552
 553   if (sock_filename[0] != '/')
 554     {
 555       clib_error_t *error;
 556       error = vlib_unix_recursive_mkdir (vlib_unix_get_runtime_dir ());
 557       if (error)
 558         {
 559           clib_error_free (error);
 560           return VNET_API_ERROR_SYSCALL_ERROR_1;
 561         }
 562
 563       sock_filename = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
 564                               sock_filename, 0);
 565     }
 566   else
 567     {
 568       sock_filename = vec_dup (sock_filename);
 569     }
 570
 571   return memif_add_socket_file (sock_id, sock_filename);
 572 }
 573
 574 int
 575 memif_delete_if (vlib_main_t * vm, memif_if_t * mif)
 576 {
 577   vnet_main_t *vnm = vnet_get_main ();
 578   memif_main_t *mm = &memif_main;
 579   memif_socket_file_t *msf =
 580     vec_elt_at_index (mm->socket_files, mif->socket_file_index);
 581   clib_error_t *err;
 582
 583   mif->flags |= MEMIF_IF_FLAG_DELETING;
 584   vec_free (mif->local_disc_string);
 585   vec_free (mif->remote_disc_string);
 586
 587   /* bring down the interface */
 588   vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
 589   vnet_sw_interface_set_flags (vnm, mif->sw_if_index, 0);
 590
 591   err = clib_error_return (0, "interface deleted");
 592   memif_disconnect (mif, err);
 593   clib_error_free (err);
 594
 595   /* remove the interface */
 596   if (mif->mode == MEMIF_INTERFACE_MODE_IP)
 597     vnet_delete_hw_interface (vnm, mif->hw_if_index);
 598   else
 599     ethernet_delete_interface (vnm, mif->hw_if_index);
 600   mif->hw_if_index = ~0;
 601
 602   /* free interface data structures */
 603   clib_spinlock_free (&mif->lockp);
 604   mhash_unset (&msf->dev_instance_by_id, &mif->id, 0);
 605
 606   /* remove socket file */
 607   if (--(msf->ref_cnt) == 0)
 608     {
 609       if (msf->is_listener)
 610         {
 611           int i;
 612           vec_foreach_index (i, msf->pending_clients)
 613           {
 614             memif_socket_close (msf->pending_clients + i);
 615           }
 616           memif_socket_close (&msf->sock);
 617           vec_free (msf->pending_clients);
 618         }
 619       mhash_free (&msf->dev_instance_by_id);
 620       hash_free (msf->dev_instance_by_fd);
 621       if (msf->sock)
 622         {
 623           err = clib_socket_close (msf->sock);
 624           if (err)
 625             clib_error_report (err);
 626           clib_mem_free (msf->sock);
 627         }
 628     }
 629
 630   memset (mif, 0, sizeof (*mif));
 631   pool_put (mm->interfaces, mif);
 632
 633   if (pool_elts (mm->interfaces) == 0)
 634     vlib_process_signal_event (vm, memif_process_node.index,
 635                                MEMIF_PROCESS_EVENT_STOP, 0);
 636
 637   return 0;
 638 }
 639
 640 /* *INDENT-OFF* */
 641 VNET_HW_INTERFACE_CLASS (memif_ip_hw_if_class, static) =
 642 {
 643   .name = "memif-ip",
 644   .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
 645 };
 646 /* *INDENT-ON* */
 647
 648 int
 649 memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args)
 650 {
 651   memif_main_t *mm = &memif_main;
 652   vlib_thread_main_t *tm = vlib_get_thread_main ();
 653   vnet_main_t *vnm = vnet_get_main ();
 654   memif_if_t *mif = 0;
 655   vnet_sw_interface_t *sw;
 656   clib_error_t *error = 0;
 657   int ret = 0;
 658   uword *p;
 659   vnet_hw_interface_t *hw;
 660   memif_socket_file_t *msf = 0;
 661   int rv = 0;
 662
 663   p = hash_get (mm->socket_file_index_by_sock_id, args->socket_id);
 664   if (p == 0)
 665     {
 666       rv = VNET_API_ERROR_INVALID_ARGUMENT;
 667       goto done;
 668     }
 669
 670   msf = vec_elt_at_index (mm->socket_files, p[0]);
 671
 672   /* existing socket file can be either master or slave but cannot be both */
 673   if (msf->ref_cnt > 0)
 674     {
 675       if ((!msf->is_listener != !args->is_master))
 676         {
 677           rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
 678           goto done;
 679         }
 680
 681       p = mhash_get (&msf->dev_instance_by_id, &args->id);
 682       if (p)
 683         {
 684           rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
 685           goto done;
 686         }
 687     }
 688
 689   /* Create new socket file */
 690   if (msf->ref_cnt == 0)
 691     {
 692       struct stat file_stat;
 693
 694       /* If we are creating listener make sure file doesn't exist or if it
 695        * exists thn delete it if it is old socket file */
 696       if (args->is_master && (stat ((char *) msf->filename, &file_stat) == 0))
 697         {
 698           if (S_ISSOCK (file_stat.st_mode))
 699             {
 700               unlink ((char *) msf->filename);
 701             }
 702           else
 703             {
 704               error = clib_error_return (0, "File exists for %s",
 705                                          msf->filename);
 706               clib_error_report (error);
 707               rv = VNET_API_ERROR_VALUE_EXIST;
 708               goto done;
 709             }
 710         }
 711
 712       mhash_init (&msf->dev_instance_by_id, sizeof (uword),
 713                   sizeof (memif_interface_id_t));
 714       msf->dev_instance_by_fd = hash_create (0, sizeof (uword));
 715       msf->is_listener = (args->is_master != 0);
 716
 717       DBG ("initializing socket file %s", msf->filename);
 718     }
 719
 720   pool_get (mm->interfaces, mif);
 721   memset (mif, 0, sizeof (*mif));
 722   mif->dev_instance = mif - mm->interfaces;
 723   mif->socket_file_index = msf - mm->socket_files;
 724   mif->id = args->id;
 725   mif->sw_if_index = mif->hw_if_index = mif->per_interface_next_index = ~0;
 726   mif->mode = args->mode;
 727   if (args->secret)
 728     mif->secret = vec_dup (args->secret);
 729
 730   if (tm->n_vlib_mains > 1)
 731     clib_spinlock_init (&mif->lockp);
 732
 733   if (mif->mode == MEMIF_INTERFACE_MODE_ETHERNET)
 734     {
 735
 736       if (!args->hw_addr_set)
 737         {
 738           f64 now = vlib_time_now (vm);
 739           u32 rnd;
 740           rnd = (u32) (now * 1e6);
 741           rnd = random_u32 (&rnd);
 742
 743           memcpy (args->hw_addr + 2, &rnd, sizeof (rnd));
 744           args->hw_addr[0] = 2;
 745           args->hw_addr[1] = 0xfe;
 746         }
 747       error = ethernet_register_interface (vnm, memif_device_class.index,
 748                                            mif->dev_instance, args->hw_addr,
 749                                            &mif->hw_if_index,
 750                                            memif_eth_flag_change);
 751     }
 752   else if (mif->mode == MEMIF_INTERFACE_MODE_IP)
 753     {
 754       mif->hw_if_index =
 755         vnet_register_interface (vnm, memif_device_class.index,
 756                                  mif->dev_instance,
 757                                  memif_ip_hw_if_class.index,
 758                                  mif->dev_instance);
 759     }
 760   else
 761     error = clib_error_return (0, "unsupported interface mode");
 762
 763   if (error)
 764     {
 765       clib_error_report (error);
 766       ret = VNET_API_ERROR_SYSCALL_ERROR_2;
 767       goto error;
 768     }
 769
 770   sw = vnet_get_hw_sw_interface (vnm, mif->hw_if_index);
 771   mif->sw_if_index = sw->sw_if_index;
 772
 773   mif->cfg.log2_ring_size = args->log2_ring_size;
 774   mif->cfg.buffer_size = args->buffer_size;
 775   mif->cfg.num_s2m_rings =
 776     args->is_master ? args->rx_queues : args->tx_queues;
 777   mif->cfg.num_m2s_rings =
 778     args->is_master ? args->tx_queues : args->rx_queues;
 779
 780   args->sw_if_index = mif->sw_if_index;
 781
 782   /* If this is new one, start listening */
 783   if (msf->is_listener && msf->ref_cnt == 0)
 784     {
 785       struct stat file_stat;
 786       clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
 787
 788       ASSERT (msf->sock == 0);
 789       msf->sock = s;
 790
 791       memset (s, 0, sizeof (clib_socket_t));
 792       s->config = (char *) msf->filename;
 793       s->flags = CLIB_SOCKET_F_IS_SERVER |
 794         CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
 795         CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
 796
 797       if ((error = clib_socket_init (s)))
 798         {
 799           clib_error_report (error);
 800           ret = VNET_API_ERROR_SYSCALL_ERROR_4;
 801           goto error;
 802         }
 803
 804       if (stat ((char *) msf->filename, &file_stat) == -1)
 805         {
 806           ret = VNET_API_ERROR_SYSCALL_ERROR_8;
 807           goto error;
 808         }
 809
 810       clib_file_t template = { 0 };
 811       template.read_function = memif_conn_fd_accept_ready;
 812       template.file_descriptor = msf->sock->fd;
 813       template.private_data = mif->socket_file_index;
 814       template.description = format (0, "memif listener %s", msf->filename);
 815       memif_file_add (&msf->sock->private_data, &template);
 816     }
 817
 818   msf->ref_cnt++;
 819
 820   if (args->is_master == 0)
 821     mif->flags |= MEMIF_IF_FLAG_IS_SLAVE;
 822
 823   hw = vnet_get_hw_interface (vnm, mif->hw_if_index);
 824   hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
 825   vnet_hw_interface_set_input_node (vnm, mif->hw_if_index,
 826                                     memif_input_node.index);
 827
 828   mhash_set (&msf->dev_instance_by_id, &mif->id, mif->dev_instance, 0);
 829
 830   if (pool_elts (mm->interfaces) == 1)
 831     {
 832       vlib_process_signal_event (vm, memif_process_node.index,
 833                                  MEMIF_PROCESS_EVENT_START, 0);
 834     }
 835   goto done;
 836
 837 error:
 838   if (mif->hw_if_index != ~0)
 839     {
 840       if (mif->mode == MEMIF_INTERFACE_MODE_IP)
 841         vnet_delete_hw_interface (vnm, mif->hw_if_index);
 842       else
 843         ethernet_delete_interface (vnm, mif->hw_if_index);
 844       mif->hw_if_index = ~0;
 845     }
 846   memif_delete_if (vm, mif);
 847   return ret;
 848
 849 done:
 850   return rv;
 851 }
 852
 853
 854 static clib_error_t *
 855 memif_init (vlib_main_t * vm)
 856 {
 857   memif_main_t *mm = &memif_main;
 858   vlib_thread_main_t *tm = vlib_get_thread_main ();
 859   u8 *filename;
 860
 861   memset (mm, 0, sizeof (memif_main_t));
 862
 863   /* initialize binary API */
 864   memif_plugin_api_hookup (vm);
 865
 866   /*
 867    * Pre-stuff socket filename pool with a non-modifieable mapping
 868    * for socket-id 0 to MEMIF_DEFAULT_SOCKET_FILENAME in the
 869    * default run-time directory.
 870    */
 871   filename = format (0, "%s/%s%c",
 872                      vlib_unix_get_runtime_dir (),
 873                      MEMIF_DEFAULT_SOCKET_FILENAME, 0);
 874   memif_add_socket_file (0, filename);
 875
 876   vec_validate_aligned (mm->rx_buffers, tm->n_vlib_mains - 1,
 877                         CLIB_CACHE_LINE_BYTES);
 878
 879   return 0;
 880 }
 881
 882 VLIB_INIT_FUNCTION (memif_init);
 883
 884 /* *INDENT-OFF* */
 885 VLIB_PLUGIN_REGISTER () = {
 886     .version = VPP_BUILD_VER,
 887     .description = "Packet Memory Interface (experimetal)",
 888 };
 889 /* *INDENT-ON* */
 890
 891 /*
 892  * fd.io coding-style-patch-verification: ON
 893  *
 894  * Local Variables:
 895  * eval: (c-set-style "gnu")
 896  * End:
 897  */