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     mq->type = MEMIF_RING_S2M;
 345   }
 346
 347   ASSERT (mif->rx_queues == 0);
 348   vec_validate_aligned (mif->rx_queues, mif->run.num_m2s_rings - 1,
 349                         CLIB_CACHE_LINE_BYTES);
 350   vec_foreach_index (i, mif->rx_queues)
 351   {
 352     memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
 353     if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
 354       return clib_error_return_unix (0, "eventfd[rx queue %u]", i);
 355     mq->int_clib_file_index = ~0;
 356     mq->ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
 357     mq->log2_ring_size = mif->cfg.log2_ring_size;
 358     mq->region = 0;
 359     mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
 360     mq->last_head = 0;
 361     mq->type = MEMIF_RING_M2S;
 362   }
 363
 364   return 0;
 365 }
 366
 367 static uword
 368 memif_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
 369 {
 370   memif_main_t *mm = &memif_main;
 371   memif_if_t *mif;
 372   clib_socket_t *sock;
 373   uword *event_data = 0, event_type;
 374   u8 enabled = 0;
 375   f64 start_time, last_run_duration = 0, now;
 376   clib_error_t *err;
 377
 378   sock = clib_mem_alloc (sizeof (clib_socket_t));
 379   memset (sock, 0, sizeof (clib_socket_t));
 380
 381   while (1)
 382     {
 383       if (enabled)
 384         vlib_process_wait_for_event_or_clock (vm, (f64) 3 -
 385                                               last_run_duration);
 386       else
 387         vlib_process_wait_for_event (vm);
 388
 389       event_type = vlib_process_get_events (vm, &event_data);
 390       vec_reset_length (event_data);
 391
 392       switch (event_type)
 393         {
 394         case ~0:
 395           break;
 396         case MEMIF_PROCESS_EVENT_START:
 397           enabled = 1;
 398           break;
 399         case MEMIF_PROCESS_EVENT_STOP:
 400           enabled = 0;
 401           continue;
 402         default:
 403           ASSERT (0);
 404         }
 405
 406       last_run_duration = start_time = vlib_time_now (vm);
 407       /* *INDENT-OFF* */
 408       pool_foreach (mif, mm->interfaces,
 409         ({
 410           memif_socket_file_t * msf = vec_elt_at_index (mm->socket_files, mif->socket_file_index);
 411           /* Allow no more than 10us without a pause */
 412           now = vlib_time_now (vm);
 413           if (now > start_time + 10e-6)
 414             {
 415               vlib_process_suspend (vm, 100e-6);        /* suspend for 100 us */
 416               start_time = vlib_time_now (vm);
 417             }
 418
 419           if ((mif->flags & MEMIF_IF_FLAG_ADMIN_UP) == 0)
 420             continue;
 421
 422           if (mif->flags & MEMIF_IF_FLAG_CONNECTING)
 423             continue;
 424
 425           if (mif->flags & MEMIF_IF_FLAG_CONNECTED)
 426             continue;
 427
 428           if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
 429             {
 430               memset (sock, 0, sizeof(clib_socket_t));
 431               sock->config = (char *) msf->filename;
 432               sock->flags = CLIB_SOCKET_F_IS_CLIENT| CLIB_SOCKET_F_SEQPACKET;
 433
 434               if ((err = clib_socket_init (sock)))
 435                 {
 436                   clib_error_free (err);
 437                 }
 438               else
 439                 {
 440                   clib_file_t t = { 0 };
 441
 442                   t.read_function = memif_slave_conn_fd_read_ready;
 443                   t.write_function = memif_slave_conn_fd_write_ready;
 444                   t.error_function = memif_slave_conn_fd_error;
 445                   t.file_descriptor = sock->fd;
 446                   t.private_data = mif->dev_instance;
 447                   memif_file_add (&sock->private_data, &t);
 448                   t.description = format (0, "%U ctl",
 449                                           format_memif_device_name,
 450                                           mif->dev_instance);
 451                   hash_set (msf->dev_instance_by_fd, sock->fd, mif->dev_instance);
 452
 453                   mif->flags |= MEMIF_IF_FLAG_CONNECTING;
 454                   mif->sock = sock;
 455                   sock = clib_mem_alloc (sizeof(clib_socket_t));
 456                 }
 457             }
 458         }));
 459       /* *INDENT-ON* */
 460       last_run_duration = vlib_time_now (vm) - last_run_duration;
 461     }
 462   return 0;
 463 }
 464
 465 /* *INDENT-OFF* */
 466 VLIB_REGISTER_NODE (memif_process_node,static) = {
 467   .function = memif_process,
 468   .type = VLIB_NODE_TYPE_PROCESS,
 469   .name = "memif-process",
 470 };
 471 /* *INDENT-ON* */
 472
 473
 474 static int
 475 memif_add_socket_file (u32 sock_id, u8 * socket_filename)
 476 {
 477   memif_main_t *mm = &memif_main;
 478   uword *p;
 479   memif_socket_file_t *msf;
 480
 481   p = hash_get (mm->socket_file_index_by_sock_id, sock_id);
 482   if (p)
 483     {
 484       msf = pool_elt_at_index (mm->socket_files, *p);
 485       if (strcmp ((char *) msf->filename, (char *) socket_filename) == 0)
 486         {
 487           /* Silently accept identical "add". */
 488           return 0;
 489         }
 490
 491       /* But don't allow a direct add of a different filename. */
 492       return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
 493     }
 494
 495   DBG ("creating socket file (uninitialized) %s", msf->filename);
 496
 497   pool_get (mm->socket_files, msf);
 498   memset (msf, 0, sizeof (memif_socket_file_t));
 499
 500   msf->filename = socket_filename;
 501   msf->socket_id = sock_id;
 502
 503   hash_set (mm->socket_file_index_by_sock_id, sock_id,
 504             msf - mm->socket_files);
 505
 506   return 0;
 507 }
 508
 509 static int
 510 memif_delete_socket_file (u32 sock_id)
 511 {
 512   memif_main_t *mm = &memif_main;
 513   uword *p;
 514   memif_socket_file_t *msf;
 515
 516   p = hash_get (mm->socket_file_index_by_sock_id, sock_id);
 517   if (!p)
 518     {
 519       /* Don't delete non-existent entries. */
 520       return VNET_API_ERROR_INVALID_ARGUMENT;
 521     }
 522
 523   msf = pool_elt_at_index (mm->socket_files, *p);
 524   if (msf->ref_cnt > 0)
 525     {
 526       return VNET_API_ERROR_UNEXPECTED_INTF_STATE;
 527     }
 528
 529   vec_free (msf->filename);
 530   pool_put (mm->socket_files, msf);
 531
 532   hash_unset (mm->socket_file_index_by_sock_id, sock_id);
 533
 534   return 0;
 535 }
 536
 537 int
 538 memif_socket_filename_add_del (u8 is_add, u32 sock_id, u8 * sock_filename)
 539 {
 540   if (sock_id == 0 || sock_id == ~0)
 541     {
 542       return VNET_API_ERROR_INVALID_ARGUMENT;
 543     }
 544
 545   if (is_add == 0)
 546     {
 547       return memif_delete_socket_file (sock_id);
 548     }
 549
 550   if (sock_filename == 0 || sock_filename[0] == 0)
 551     {
 552       return VNET_API_ERROR_INVALID_ARGUMENT;
 553     }
 554
 555   if (sock_filename[0] != '/')
 556     {
 557       clib_error_t *error;
 558       error = vlib_unix_recursive_mkdir (vlib_unix_get_runtime_dir ());
 559       if (error)
 560         {
 561           clib_error_free (error);
 562           return VNET_API_ERROR_SYSCALL_ERROR_1;
 563         }
 564
 565       sock_filename = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
 566                               sock_filename, 0);
 567     }
 568   else
 569     {
 570       sock_filename = vec_dup (sock_filename);
 571     }
 572
 573   return memif_add_socket_file (sock_id, sock_filename);
 574 }
 575
 576 int
 577 memif_delete_if (vlib_main_t * vm, memif_if_t * mif)
 578 {
 579   vnet_main_t *vnm = vnet_get_main ();
 580   memif_main_t *mm = &memif_main;
 581   memif_socket_file_t *msf =
 582     vec_elt_at_index (mm->socket_files, mif->socket_file_index);
 583   clib_error_t *err;
 584
 585   mif->flags |= MEMIF_IF_FLAG_DELETING;
 586   vec_free (mif->local_disc_string);
 587   vec_free (mif->remote_disc_string);
 588
 589   /* bring down the interface */
 590   vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
 591   vnet_sw_interface_set_flags (vnm, mif->sw_if_index, 0);
 592
 593   err = clib_error_return (0, "interface deleted");
 594   memif_disconnect (mif, err);
 595   clib_error_free (err);
 596
 597   if (mif->hw_if_index != ~0)
 598     {
 599       /* remove the interface */
 600       if (mif->mode == MEMIF_INTERFACE_MODE_IP)
 601         vnet_delete_hw_interface (vnm, mif->hw_if_index);
 602       else
 603         ethernet_delete_interface (vnm, mif->hw_if_index);
 604       mif->hw_if_index = ~0;
 605     }
 606
 607   /* free interface data structures */
 608   clib_spinlock_free (&mif->lockp);
 609   mhash_unset (&msf->dev_instance_by_id, &mif->id, 0);
 610
 611   /* remove socket file */
 612   if (--(msf->ref_cnt) == 0)
 613     {
 614       if (msf->is_listener)
 615         {
 616           int i;
 617           vec_foreach_index (i, msf->pending_clients)
 618           {
 619             memif_socket_close (msf->pending_clients + i);
 620           }
 621           memif_socket_close (&msf->sock);
 622           vec_free (msf->pending_clients);
 623         }
 624       mhash_free (&msf->dev_instance_by_id);
 625       hash_free (msf->dev_instance_by_fd);
 626       if (msf->sock)
 627         {
 628           err = clib_socket_close (msf->sock);
 629           if (err)
 630             clib_error_report (err);
 631           clib_mem_free (msf->sock);
 632         }
 633     }
 634
 635   memset (mif, 0, sizeof (*mif));
 636   pool_put (mm->interfaces, mif);
 637
 638   if (pool_elts (mm->interfaces) == 0)
 639     vlib_process_signal_event (vm, memif_process_node.index,
 640                                MEMIF_PROCESS_EVENT_STOP, 0);
 641
 642   return 0;
 643 }
 644
 645 /* *INDENT-OFF* */
 646 VNET_HW_INTERFACE_CLASS (memif_ip_hw_if_class, static) =
 647 {
 648   .name = "memif-ip",
 649   .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
 650 };
 651 /* *INDENT-ON* */
 652
 653 int
 654 memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args)
 655 {
 656   memif_main_t *mm = &memif_main;
 657   vlib_thread_main_t *tm = vlib_get_thread_main ();
 658   vnet_main_t *vnm = vnet_get_main ();
 659   memif_if_t *mif = 0;
 660   vnet_sw_interface_t *sw;
 661   clib_error_t *error = 0;
 662   int ret = 0;
 663   uword *p;
 664   vnet_hw_interface_t *hw;
 665   memif_socket_file_t *msf = 0;
 666   int rv = 0;
 667
 668   p = hash_get (mm->socket_file_index_by_sock_id, args->socket_id);
 669   if (p == 0)
 670     {
 671       rv = VNET_API_ERROR_INVALID_ARGUMENT;
 672       goto done;
 673     }
 674
 675   msf = vec_elt_at_index (mm->socket_files, p[0]);
 676
 677   /* existing socket file can be either master or slave but cannot be both */
 678   if (msf->ref_cnt > 0)
 679     {
 680       if ((!msf->is_listener != !args->is_master))
 681         {
 682           rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
 683           goto done;
 684         }
 685
 686       p = mhash_get (&msf->dev_instance_by_id, &args->id);
 687       if (p)
 688         {
 689           rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
 690           goto done;
 691         }
 692     }
 693
 694   /* Create new socket file */
 695   if (msf->ref_cnt == 0)
 696     {
 697       struct stat file_stat;
 698
 699       /* If we are creating listener make sure file doesn't exist or if it
 700        * exists thn delete it if it is old socket file */
 701       if (args->is_master && (stat ((char *) msf->filename, &file_stat) == 0))
 702         {
 703           if (S_ISSOCK (file_stat.st_mode))
 704             {
 705               unlink ((char *) msf->filename);
 706             }
 707           else
 708             {
 709               error = clib_error_return (0, "File exists for %s",
 710                                          msf->filename);
 711               clib_error_report (error);
 712               rv = VNET_API_ERROR_VALUE_EXIST;
 713               goto done;
 714             }
 715         }
 716
 717       mhash_init (&msf->dev_instance_by_id, sizeof (uword),
 718                   sizeof (memif_interface_id_t));
 719       msf->dev_instance_by_fd = hash_create (0, sizeof (uword));
 720       msf->is_listener = (args->is_master != 0);
 721
 722       DBG ("initializing socket file %s", msf->filename);
 723     }
 724
 725   pool_get (mm->interfaces, mif);
 726   memset (mif, 0, sizeof (*mif));
 727   mif->dev_instance = mif - mm->interfaces;
 728   mif->socket_file_index = msf - mm->socket_files;
 729   mif->id = args->id;
 730   mif->sw_if_index = mif->hw_if_index = mif->per_interface_next_index = ~0;
 731   mif->mode = args->mode;
 732   if (args->secret)
 733     mif->secret = vec_dup (args->secret);
 734
 735   if (tm->n_vlib_mains > 1)
 736     clib_spinlock_init (&mif->lockp);
 737
 738   if (mif->mode == MEMIF_INTERFACE_MODE_ETHERNET)
 739     {
 740
 741       if (!args->hw_addr_set)
 742         {
 743           f64 now = vlib_time_now (vm);
 744           u32 rnd;
 745           rnd = (u32) (now * 1e6);
 746           rnd = random_u32 (&rnd);
 747
 748           memcpy (args->hw_addr + 2, &rnd, sizeof (rnd));
 749           args->hw_addr[0] = 2;
 750           args->hw_addr[1] = 0xfe;
 751         }
 752       error = ethernet_register_interface (vnm, memif_device_class.index,
 753                                            mif->dev_instance, args->hw_addr,
 754                                            &mif->hw_if_index,
 755                                            memif_eth_flag_change);
 756     }
 757   else if (mif->mode == MEMIF_INTERFACE_MODE_IP)
 758     {
 759       mif->hw_if_index =
 760         vnet_register_interface (vnm, memif_device_class.index,
 761                                  mif->dev_instance,
 762                                  memif_ip_hw_if_class.index,
 763                                  mif->dev_instance);
 764     }
 765   else
 766     error = clib_error_return (0, "unsupported interface mode");
 767
 768   if (error)
 769     {
 770       clib_error_report (error);
 771       ret = VNET_API_ERROR_SYSCALL_ERROR_2;
 772       goto error;
 773     }
 774
 775   sw = vnet_get_hw_sw_interface (vnm, mif->hw_if_index);
 776   mif->sw_if_index = sw->sw_if_index;
 777
 778   mif->cfg.log2_ring_size = args->log2_ring_size;
 779   mif->cfg.buffer_size = args->buffer_size;
 780   mif->cfg.num_s2m_rings =
 781     args->is_master ? args->rx_queues : args->tx_queues;
 782   mif->cfg.num_m2s_rings =
 783     args->is_master ? args->tx_queues : args->rx_queues;
 784
 785   args->sw_if_index = mif->sw_if_index;
 786
 787   /* If this is new one, start listening */
 788   if (msf->is_listener && msf->ref_cnt == 0)
 789     {
 790       struct stat file_stat;
 791       clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
 792
 793       ASSERT (msf->sock == 0);
 794       msf->sock = s;
 795
 796       memset (s, 0, sizeof (clib_socket_t));
 797       s->config = (char *) msf->filename;
 798       s->flags = CLIB_SOCKET_F_IS_SERVER |
 799         CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
 800         CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
 801
 802       if ((error = clib_socket_init (s)))
 803         {
 804           clib_error_report (error);
 805           ret = VNET_API_ERROR_SYSCALL_ERROR_4;
 806           goto error;
 807         }
 808
 809       if (stat ((char *) msf->filename, &file_stat) == -1)
 810         {
 811           ret = VNET_API_ERROR_SYSCALL_ERROR_8;
 812           goto error;
 813         }
 814
 815       clib_file_t template = { 0 };
 816       template.read_function = memif_conn_fd_accept_ready;
 817       template.file_descriptor = msf->sock->fd;
 818       template.private_data = mif->socket_file_index;
 819       template.description = format (0, "memif listener %s", msf->filename);
 820       memif_file_add (&msf->sock->private_data, &template);
 821     }
 822
 823   msf->ref_cnt++;
 824
 825   if (args->is_master == 0)
 826     mif->flags |= MEMIF_IF_FLAG_IS_SLAVE;
 827
 828   hw = vnet_get_hw_interface (vnm, mif->hw_if_index);
 829   hw->flags |= VNET_HW_INTERFACE_FLAG_SUPPORTS_INT_MODE;
 830   vnet_hw_interface_set_input_node (vnm, mif->hw_if_index,
 831                                     memif_input_node.index);
 832
 833   mhash_set (&msf->dev_instance_by_id, &mif->id, mif->dev_instance, 0);
 834
 835   if (pool_elts (mm->interfaces) == 1)
 836     {
 837       vlib_process_signal_event (vm, memif_process_node.index,
 838                                  MEMIF_PROCESS_EVENT_START, 0);
 839     }
 840   goto done;
 841
 842 error:
 843   if (mif->hw_if_index != ~0)
 844     {
 845       if (mif->mode == MEMIF_INTERFACE_MODE_IP)
 846         vnet_delete_hw_interface (vnm, mif->hw_if_index);
 847       else
 848         ethernet_delete_interface (vnm, mif->hw_if_index);
 849       mif->hw_if_index = ~0;
 850     }
 851   memif_delete_if (vm, mif);
 852   return ret;
 853
 854 done:
 855   return rv;
 856 }
 857
 858
 859 static clib_error_t *
 860 memif_init (vlib_main_t * vm)
 861 {
 862   memif_main_t *mm = &memif_main;
 863   vlib_thread_main_t *tm = vlib_get_thread_main ();
 864   u8 *filename;
 865
 866   memset (mm, 0, sizeof (memif_main_t));
 867
 868   /* initialize binary API */
 869   memif_plugin_api_hookup (vm);
 870
 871   /*
 872    * Pre-stuff socket filename pool with a non-modifieable mapping
 873    * for socket-id 0 to MEMIF_DEFAULT_SOCKET_FILENAME in the
 874    * default run-time directory.
 875    */
 876   filename = format (0, "%s/%s%c",
 877                      vlib_unix_get_runtime_dir (),
 878                      MEMIF_DEFAULT_SOCKET_FILENAME, 0);
 879   memif_add_socket_file (0, filename);
 880
 881   vec_validate_aligned (mm->rx_buffers, tm->n_vlib_mains - 1,
 882                         CLIB_CACHE_LINE_BYTES);
 883
 884   return 0;
 885 }
 886
 887 VLIB_INIT_FUNCTION (memif_init);
 888
 889 /* *INDENT-OFF* */
 890 VLIB_PLUGIN_REGISTER () = {
 891     .version = VPP_BUILD_VER,
 892     .description = "Packet Memory Interface (experimetal)",
 893 };
 894 /* *INDENT-ON* */
 895
 896 /*
 897  * fd.io coding-style-patch-verification: ON
 898  *
 899  * Local Variables:
 900  * eval: (c-set-style "gnu")
 901  * End:
 902  */