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 <vnet/plugin/plugin.h>
  37 #include <vnet/ethernet/ethernet.h>
  38 #include <vnet/interface/rx_queue_funcs.h>
  39 #include <vnet/interface/tx_queue_funcs.h>
  40 #include <vpp/app/version.h>
  41 #include <memif/memif.h>
  42 #include <memif/private.h>
  43
  44 memif_main_t memif_main;
  45
  46 static u32
  47 memif_eth_flag_change (vnet_main_t * vnm, vnet_hw_interface_t * hi, u32 flags)
  48 {
  49   /* nothing for now */
  50   return 0;
  51 }
  52
  53 static void
  54 memif_queue_intfd_close (memif_queue_t * mq)
  55 {
  56   if (mq->int_clib_file_index != ~0)
  57     {
  58       memif_file_del_by_index (mq->int_clib_file_index);
  59       mq->int_clib_file_index = ~0;
  60       mq->int_fd = -1;
  61     }
  62   else if (mq->int_fd > -1)
  63     {
  64       close (mq->int_fd);
  65       mq->int_fd = -1;
  66     }
  67 }
  68
  69 static void
  70 memif_disconnect_free_zc_queue_buffer (memif_queue_t * mq, u8 is_rx)
  71 {
  72   vlib_main_t *vm = vlib_get_main ();
  73   u16 ring_size, n_slots, mask, start;
  74
  75   ring_size = 1 << mq->log2_ring_size;
  76   mask = ring_size - 1;
  77   n_slots = mq->ring->head - mq->last_tail;
  78   start = mq->last_tail & mask;
  79   if (is_rx)
  80     vlib_buffer_free_from_ring (vm, mq->buffers, start, ring_size, n_slots);
  81   else
  82     vlib_buffer_free_from_ring_no_next (vm, mq->buffers, start, ring_size,
  83                                         n_slots);
  84   vec_free (mq->buffers);
  85 }
  86
  87 void
  88 memif_disconnect (memif_if_t * mif, clib_error_t * err)
  89 {
  90   memif_main_t *mm = &memif_main;
  91   vnet_main_t *vnm = vnet_get_main ();
  92   memif_region_t *mr;
  93   memif_queue_t *mq;
  94   int i;
  95
  96   if (mif == 0)
  97     return;
  98
  99   memif_log_debug (mif, "disconnect %u (%v)", mif->dev_instance,
 100                    err ? err->what : 0);
 101
 102   if (err)
 103     {
 104       clib_error_t *e = 0;
 105       mif->local_disc_string = vec_dup (err->what);
 106       if (mif->sock && clib_socket_is_connected (mif->sock))
 107         e = memif_msg_send_disconnect (mif, err);
 108       clib_error_free (e);
 109     }
 110
 111   /* set interface down */
 112   mif->flags &= ~(MEMIF_IF_FLAG_CONNECTED | MEMIF_IF_FLAG_CONNECTING);
 113   if (mif->hw_if_index != ~0)
 114     vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
 115
 116   /* close connection socket */
 117   if (mif->sock && mif->sock->fd)
 118     {
 119       memif_socket_file_t *msf = vec_elt_at_index (mm->socket_files,
 120                                                    mif->socket_file_index);
 121       hash_unset (msf->dev_instance_by_fd, mif->sock->fd);
 122       memif_socket_close (&mif->sock);
 123     }
 124   else if (mif->sock)
 125     {
 126       clib_error_t *err;
 127       err = clib_socket_close (mif->sock);
 128       if (err)
 129         {
 130           memif_log_err (mif, "%U", format_clib_error, err);
 131           clib_error_free (err);
 132         }
 133       clib_mem_free (mif->sock);
 134     }
 135
 136   /* *INDENT-OFF* */
 137   vec_foreach_index (i, mif->rx_queues)
 138     {
 139       mq = vec_elt_at_index (mif->rx_queues, i);
 140       if (mq->ring)
 141         {
 142           if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
 143           {
 144             memif_disconnect_free_zc_queue_buffer(mq, 1);
 145           }
 146           mq->ring = 0;
 147         }
 148     }
 149   vnet_hw_if_unregister_all_rx_queues (vnm, mif->hw_if_index);
 150
 151   /* *INDENT-OFF* */
 152   vec_foreach_index (i, mif->tx_queues)
 153   {
 154     mq = vec_elt_at_index (mif->tx_queues, i);
 155     if (mq->ring)
 156     {
 157       if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
 158       {
 159         memif_disconnect_free_zc_queue_buffer(mq, 0);
 160       }
 161       clib_spinlock_free (&mq->lockp);
 162     }
 163     mq->ring = 0;
 164   }
 165   vnet_hw_if_unregister_all_tx_queues (vnm, mif->hw_if_index);
 166   vnet_hw_if_update_runtime_data (vnm, mif->hw_if_index);
 167
 168   /* free tx and rx queues */
 169   vec_foreach (mq, mif->rx_queues)
 170     memif_queue_intfd_close (mq);
 171   vec_free (mif->rx_queues);
 172
 173   vec_foreach (mq, mif->tx_queues)
 174     memif_queue_intfd_close (mq);
 175   vec_free (mif->tx_queues);
 176
 177   /* free memory regions */
 178   vec_foreach (mr, mif->regions)
 179     {
 180       int rv;
 181       if (mr->is_external)
 182         continue;
 183       if ((rv = munmap (mr->shm, mr->region_size)))
 184         memif_log_err (mif, "munmap failed, rv = %d", rv);
 185       if (mr->fd > -1)
 186         close (mr->fd);
 187     }
 188   /* *INDENT-ON* */
 189   vec_free (mif->regions);
 190   vec_free (mif->remote_name);
 191   vec_free (mif->remote_if_name);
 192   clib_fifo_free (mif->msg_queue);
 193 }
 194
 195 static clib_error_t *
 196 memif_int_fd_write_ready (clib_file_t * uf)
 197 {
 198   memif_main_t *mm = &memif_main;
 199   u16 qid = uf->private_data & 0xFFFF;
 200   memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data >> 16);
 201
 202   memif_log_warn (mif, "unexpected EPOLLOUT on RX for queue %u", qid);
 203   return 0;
 204 }
 205
 206 static clib_error_t *
 207 memif_int_fd_read_ready (clib_file_t * uf)
 208 {
 209   memif_main_t *mm = &memif_main;
 210   vnet_main_t *vnm = vnet_get_main ();
 211   u16 qid = uf->private_data & 0xFFFF;
 212   memif_if_t *mif = vec_elt_at_index (mm->interfaces, uf->private_data >> 16);
 213   memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, qid);
 214   u64 b;
 215   ssize_t size;
 216
 217   size = read (uf->file_descriptor, &b, sizeof (b));
 218   if (size < 0)
 219     {
 220       memif_log_debug (mif, "Failed to read from socket");
 221       return 0;
 222     }
 223
 224   vnet_hw_if_rx_queue_set_int_pending (vnm, mq->queue_index);
 225   mq->int_count++;
 226
 227   return 0;
 228 }
 229
 230
 231 clib_error_t *
 232 memif_connect (memif_if_t * mif)
 233 {
 234   memif_main_t *mm = &memif_main;
 235   vlib_main_t *vm = vlib_get_main ();
 236   vnet_main_t *vnm = vnet_get_main ();
 237   clib_file_t template = { 0 };
 238   memif_region_t *mr;
 239   int i, j;
 240   u32 n_txqs = 0, n_threads = vlib_get_n_threads ();
 241   clib_error_t *err = NULL;
 242   u8 max_log2_ring_sz = 0;
 243
 244   memif_log_debug (mif, "connect %u", mif->dev_instance);
 245
 246   vec_free (mif->local_disc_string);
 247   vec_free (mif->remote_disc_string);
 248
 249   /* *INDENT-OFF* */
 250   vec_foreach (mr, mif->regions)
 251     {
 252       if (mr->shm)
 253         continue;
 254
 255       if (mr->fd < 0)
 256         {
 257           err = clib_error_return (0, "no memory region fd");
 258           goto error;
 259         }
 260
 261       if ((mr->shm = mmap (NULL, mr->region_size, PROT_READ | PROT_WRITE,
 262                            MAP_SHARED, mr->fd, 0)) == MAP_FAILED)
 263         {
 264           err = clib_error_return_unix (0, "mmap");
 265           goto error;
 266         }
 267     }
 268   /* *INDENT-ON* */
 269
 270   template.read_function = memif_int_fd_read_ready;
 271   template.write_function = memif_int_fd_write_ready;
 272
 273   /* *INDENT-OFF* */
 274   vec_foreach_index (i, mif->tx_queues)
 275     {
 276       memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
 277       max_log2_ring_sz = clib_max (max_log2_ring_sz, mq->log2_ring_size);
 278
 279       mq->ring = mif->regions[mq->region].shm + mq->offset;
 280       if (mq->ring->cookie != MEMIF_COOKIE)
 281         {
 282           err = clib_error_return (0, "wrong cookie on tx ring %u", i);
 283           goto error;
 284         }
 285       mq->queue_index =
 286         vnet_hw_if_register_tx_queue (vnm, mif->hw_if_index, i);
 287       clib_spinlock_init (&mq->lockp);
 288     }
 289
 290   if (vec_len (mif->tx_queues) > 0)
 291     {
 292       n_txqs = vec_len (mif->tx_queues);
 293       for (j = 0; j < n_threads; j++)
 294         {
 295           u32 qi = mif->tx_queues[j % n_txqs].queue_index;
 296           vnet_hw_if_tx_queue_assign_thread (vnm, qi, j);
 297         }
 298     }
 299
 300   vec_foreach_index (i, mif->rx_queues)
 301     {
 302       memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
 303       u32 ti;
 304       u32 qi;
 305       int rv;
 306
 307       max_log2_ring_sz = clib_max (max_log2_ring_sz, mq->log2_ring_size);
 308
 309       mq->ring = mif->regions[mq->region].shm + mq->offset;
 310       if (mq->ring->cookie != MEMIF_COOKIE)
 311         {
 312           err = clib_error_return (0, "wrong cookie on tx ring %u", i);
 313           goto error;
 314         }
 315       qi = vnet_hw_if_register_rx_queue (vnm, mif->hw_if_index, i,
 316                                          VNET_HW_IF_RXQ_THREAD_ANY);
 317       mq->queue_index = qi;
 318       if (mq->int_fd > -1)
 319         {
 320           template.file_descriptor = mq->int_fd;
 321           template.private_data = (mif->dev_instance << 16) | (i & 0xFFFF);
 322           template.description = format (0, "%U rx %u int",
 323                                          format_memif_device_name,
 324                                          mif->dev_instance, i);
 325           memif_file_add (&mq->int_clib_file_index, &template);
 326           vnet_hw_if_set_rx_queue_file_index (vnm, qi,
 327                                               mq->int_clib_file_index);
 328         }
 329       ti = vnet_hw_if_get_rx_queue_thread_index (vnm, qi);
 330       mq->buffer_pool_index = vlib_buffer_pool_get_default_for_numa (
 331         vm, vlib_get_main_by_index (ti)->numa_node);
 332       rv = vnet_hw_if_set_rx_queue_mode (vnm, qi, VNET_HW_IF_RX_MODE_DEFAULT);
 333       vnet_hw_if_update_runtime_data (vnm, mif->hw_if_index);
 334
 335       if (rv)
 336         memif_log_err
 337           (mif, "Warning: unable to set rx mode for interface %d queue %d: "
 338            "rc=%d", mif->hw_if_index, i, rv);
 339       else
 340         {
 341           vnet_hw_if_rx_mode rxmode = vnet_hw_if_get_rx_queue_mode (vnm, qi);
 342
 343           if (rxmode == VNET_HW_IF_RX_MODE_POLLING)
 344             mq->ring->flags |= MEMIF_RING_FLAG_MASK_INT;
 345           else
 346             vnet_hw_if_rx_queue_set_int_pending (vnm, qi);
 347         }
 348     }
 349   /* *INDENT-ON* */
 350
 351   if (1 << max_log2_ring_sz > vec_len (mm->per_thread_data[0].desc_data))
 352     {
 353       memif_per_thread_data_t *ptd;
 354       int with_barrier = 1;
 355
 356       if (vlib_worker_thread_barrier_held ())
 357         with_barrier = 0;
 358
 359       if (with_barrier)
 360         vlib_worker_thread_barrier_sync (vm);
 361
 362       vec_foreach (ptd, mm->per_thread_data)
 363         {
 364           vec_validate_aligned (ptd->desc_data, pow2_mask (max_log2_ring_sz),
 365                                 CLIB_CACHE_LINE_BYTES);
 366           vec_validate_aligned (ptd->desc_len, pow2_mask (max_log2_ring_sz),
 367                                 CLIB_CACHE_LINE_BYTES);
 368           vec_validate_aligned (ptd->desc_status, pow2_mask (max_log2_ring_sz),
 369                                 CLIB_CACHE_LINE_BYTES);
 370         }
 371       if (with_barrier)
 372         vlib_worker_thread_barrier_release (vm);
 373     }
 374
 375   mif->flags &= ~MEMIF_IF_FLAG_CONNECTING;
 376   mif->flags |= MEMIF_IF_FLAG_CONNECTED;
 377
 378   vnet_hw_interface_set_flags (vnm, mif->hw_if_index,
 379                                VNET_HW_INTERFACE_FLAG_LINK_UP);
 380   return 0;
 381
 382 error:
 383   memif_log_err (mif, "%U", format_clib_error, err);
 384   return err;
 385 }
 386
 387 static_always_inline memif_ring_t *
 388 memif_get_ring (memif_if_t * mif, memif_ring_type_t type, u16 ring_num)
 389 {
 390   if (vec_len (mif->regions) == 0)
 391     return NULL;
 392   void *p = mif->regions[0].shm;
 393   int ring_size =
 394     sizeof (memif_ring_t) +
 395     sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size);
 396   p += (ring_num + type * mif->run.num_s2m_rings) * ring_size;
 397
 398   return (memif_ring_t *) p;
 399 }
 400
 401 clib_error_t *
 402 memif_init_regions_and_queues (memif_if_t * mif)
 403 {
 404   vlib_main_t *vm = vlib_get_main ();
 405   memif_socket_file_t *msf;
 406   memif_ring_t *ring = NULL;
 407   int fd, i, j;
 408   u64 buffer_offset;
 409   memif_region_t *r;
 410   clib_error_t *err;
 411
 412   ASSERT (vec_len (mif->regions) == 0);
 413   vec_add2_aligned (mif->regions, r, 1, CLIB_CACHE_LINE_BYTES);
 414
 415   buffer_offset = (mif->run.num_s2m_rings + mif->run.num_m2s_rings) *
 416     (sizeof (memif_ring_t) +
 417      sizeof (memif_desc_t) * (1 << mif->run.log2_ring_size));
 418
 419   r->region_size = buffer_offset;
 420
 421   if ((mif->flags & MEMIF_IF_FLAG_ZERO_COPY) == 0)
 422     r->region_size += mif->run.buffer_size * (1 << mif->run.log2_ring_size) *
 423       (mif->run.num_s2m_rings + mif->run.num_m2s_rings);
 424
 425   if ((fd = clib_mem_vm_create_fd (CLIB_MEM_PAGE_SZ_DEFAULT, "%U region 0",
 426                                    format_memif_device_name,
 427                                    mif->dev_instance)) == -1)
 428     {
 429       err = clib_mem_get_last_error ();
 430       goto error;
 431     }
 432
 433   if ((ftruncate (fd, r->region_size)) == -1)
 434     {
 435       err = clib_error_return_unix (0, "ftruncate");
 436       goto error;
 437     }
 438
 439   msf = pool_elt_at_index (memif_main.socket_files, mif->socket_file_index);
 440   r->shm = clib_mem_vm_map_shared (0, r->region_size, fd, 0, "memif%lu/%lu:0",
 441                                    msf->socket_id, mif->id);
 442
 443   if (r->shm == CLIB_MEM_VM_MAP_FAILED)
 444     {
 445       err = clib_error_return_unix (0, "memif shared region map failed");
 446       goto error;
 447     }
 448
 449   r->fd = fd;
 450
 451   if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
 452     {
 453       vlib_buffer_pool_t *bp;
 454       /* *INDENT-OFF* */
 455       vec_foreach (bp, vm->buffer_main->buffer_pools)
 456         {
 457           vlib_physmem_map_t *pm;
 458           pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
 459           vec_add2_aligned (mif->regions, r, 1, CLIB_CACHE_LINE_BYTES);
 460           r->fd = pm->fd;
 461           r->region_size = pm->n_pages << pm->log2_page_size;
 462           r->shm = pm->base;
 463           r->is_external = 1;
 464         }
 465       /* *INDENT-ON* */
 466     }
 467
 468   for (i = 0; i < mif->run.num_s2m_rings; i++)
 469     {
 470       ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
 471       ring->head = ring->tail = 0;
 472       ring->cookie = MEMIF_COOKIE;
 473
 474       if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
 475         continue;
 476
 477       for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
 478         {
 479           u16 slot = i * (1 << mif->run.log2_ring_size) + j;
 480           ring->desc[j].region = 0;
 481           ring->desc[j].offset =
 482             buffer_offset + (u32) (slot * mif->run.buffer_size);
 483           ring->desc[j].length = mif->run.buffer_size;
 484         }
 485     }
 486   for (i = 0; i < mif->run.num_m2s_rings; i++)
 487     {
 488       ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
 489       ring->head = ring->tail = 0;
 490       ring->cookie = MEMIF_COOKIE;
 491
 492       if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
 493         continue;
 494
 495       for (j = 0; j < (1 << mif->run.log2_ring_size); j++)
 496         {
 497           u16 slot =
 498             (i + mif->run.num_s2m_rings) * (1 << mif->run.log2_ring_size) + j;
 499           ring->desc[j].region = 0;
 500           ring->desc[j].offset =
 501             buffer_offset + (u32) (slot * mif->run.buffer_size);
 502           ring->desc[j].length = mif->run.buffer_size;
 503         }
 504     }
 505
 506   ASSERT (mif->tx_queues == 0);
 507   vec_validate_aligned (mif->tx_queues, mif->run.num_s2m_rings - 1,
 508                         CLIB_CACHE_LINE_BYTES);
 509
 510   /* *INDENT-OFF* */
 511   vec_foreach_index (i, mif->tx_queues)
 512     {
 513       memif_queue_t *mq = vec_elt_at_index (mif->tx_queues, i);
 514       if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
 515         {
 516           err = clib_error_return_unix (0, "eventfd[tx queue %u]", i);
 517           goto error;
 518         }
 519
 520       mq->int_clib_file_index = ~0;
 521       mq->ring = memif_get_ring (mif, MEMIF_RING_S2M, i);
 522       mq->log2_ring_size = mif->cfg.log2_ring_size;
 523       mq->region = 0;
 524       mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
 525       mq->last_head = 0;
 526       mq->type = MEMIF_RING_S2M;
 527       if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
 528         vec_validate_aligned (mq->buffers, 1 << mq->log2_ring_size,
 529                               CLIB_CACHE_LINE_BYTES);
 530     }
 531   /* *INDENT-ON* */
 532
 533   ASSERT (mif->rx_queues == 0);
 534   vec_validate_aligned (mif->rx_queues, mif->run.num_m2s_rings - 1,
 535                         CLIB_CACHE_LINE_BYTES);
 536
 537   /* *INDENT-OFF* */
 538   vec_foreach_index (i, mif->rx_queues)
 539     {
 540       memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, i);
 541       if ((mq->int_fd = eventfd (0, EFD_NONBLOCK)) < 0)
 542         {
 543           err = clib_error_return_unix (0, "eventfd[rx queue %u]", i);
 544           goto error;
 545         }
 546       mq->int_clib_file_index = ~0;
 547       mq->ring = memif_get_ring (mif, MEMIF_RING_M2S, i);
 548       mq->log2_ring_size = mif->cfg.log2_ring_size;
 549       mq->region = 0;
 550       mq->offset = (void *) mq->ring - (void *) mif->regions[mq->region].shm;
 551       mq->last_head = 0;
 552       mq->type = MEMIF_RING_M2S;
 553       if (mif->flags & MEMIF_IF_FLAG_ZERO_COPY)
 554         vec_validate_aligned (mq->buffers, 1 << mq->log2_ring_size,
 555                               CLIB_CACHE_LINE_BYTES);
 556     }
 557   /* *INDENT-ON* */
 558
 559   return 0;
 560
 561 error:
 562   memif_log_err (mif, "%U", format_clib_error, err);
 563   return err;
 564 }
 565
 566 static uword
 567 memif_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f)
 568 {
 569   memif_main_t *mm = &memif_main;
 570   memif_if_t *mif;
 571   clib_socket_t *sock;
 572   uword *event_data = 0, event_type;
 573   u8 enabled = 0;
 574   f64 start_time, last_run_duration = 0, now;
 575   clib_error_t *err;
 576
 577   sock = clib_mem_alloc (sizeof (clib_socket_t));
 578   clib_memset (sock, 0, sizeof (clib_socket_t));
 579
 580   while (1)
 581     {
 582       if (enabled)
 583         vlib_process_wait_for_event_or_clock (vm, (f64) 3 -
 584                                               last_run_duration);
 585       else
 586         vlib_process_wait_for_event (vm);
 587
 588       event_type = vlib_process_get_events (vm, &event_data);
 589       vec_reset_length (event_data);
 590
 591       switch (event_type)
 592         {
 593         case ~0:
 594           break;
 595         case MEMIF_PROCESS_EVENT_START:
 596           enabled = 1;
 597           break;
 598         case MEMIF_PROCESS_EVENT_STOP:
 599           enabled = 0;
 600           continue;
 601         case MEMIF_PROCESS_EVENT_ADMIN_UP_DOWN:
 602           break;
 603         default:
 604           ASSERT (0);
 605         }
 606
 607       last_run_duration = start_time = vlib_time_now (vm);
 608       /* *INDENT-OFF* */
 609       pool_foreach (mif, mm->interfaces)
 610          {
 611           memif_socket_file_t * msf = vec_elt_at_index (mm->socket_files, mif->socket_file_index);
 612           /* Allow no more than 10us without a pause */
 613           now = vlib_time_now (vm);
 614           if (now > start_time + 10e-6)
 615             {
 616               vlib_process_suspend (vm, 100e-6);        /* suspend for 100 us */
 617               start_time = vlib_time_now (vm);
 618             }
 619
 620           if ((mif->flags & MEMIF_IF_FLAG_ADMIN_UP) == 0)
 621             continue;
 622
 623           if (mif->flags & MEMIF_IF_FLAG_CONNECTING)
 624             continue;
 625
 626           if (mif->flags & MEMIF_IF_FLAG_CONNECTED)
 627             continue;
 628
 629           if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
 630             {
 631               clib_memset (sock, 0, sizeof(clib_socket_t));
 632               sock->config = (char *) msf->filename;
 633               sock->flags = CLIB_SOCKET_F_IS_CLIENT | CLIB_SOCKET_F_SEQPACKET |
 634                             CLIB_SOCKET_F_BLOCKING;
 635
 636               if ((err = clib_socket_init (sock)))
 637                 {
 638                   clib_error_free (err);
 639                 }
 640               else
 641                 {
 642                   clib_file_t t = { 0 };
 643
 644                   t.read_function = memif_slave_conn_fd_read_ready;
 645                   t.write_function = memif_slave_conn_fd_write_ready;
 646                   t.error_function = memif_slave_conn_fd_error;
 647                   t.file_descriptor = sock->fd;
 648                   t.private_data = mif->dev_instance;
 649                   memif_file_add (&sock->private_data, &t);
 650                   t.description = format (0, "%U ctl",
 651                                           format_memif_device_name,
 652                                           mif->dev_instance);
 653                   hash_set (msf->dev_instance_by_fd, sock->fd, mif->dev_instance);
 654
 655                   mif->flags |= MEMIF_IF_FLAG_CONNECTING;
 656                   mif->sock = sock;
 657                   sock = clib_mem_alloc (sizeof(clib_socket_t));
 658                 }
 659             }
 660         }
 661       /* *INDENT-ON* */
 662       last_run_duration = vlib_time_now (vm) - last_run_duration;
 663     }
 664   return 0;
 665 }
 666
 667 /* *INDENT-OFF* */
 668 VLIB_REGISTER_NODE (memif_process_node,static) = {
 669   .function = memif_process,
 670   .type = VLIB_NODE_TYPE_PROCESS,
 671   .name = "memif-process",
 672 };
 673 /* *INDENT-ON* */
 674
 675 static int
 676 memif_add_socket_file (u32 sock_id, u8 * socket_filename)
 677 {
 678   memif_main_t *mm = &memif_main;
 679   uword *p;
 680   memif_socket_file_t *msf;
 681
 682   p = hash_get (mm->socket_file_index_by_sock_id, sock_id);
 683   if (p)
 684     {
 685       msf = pool_elt_at_index (mm->socket_files, *p);
 686       if (strcmp ((char *) msf->filename, (char *) socket_filename) == 0)
 687         {
 688           /* Silently accept identical "add". */
 689           return 0;
 690         }
 691
 692       /* But don't allow a direct add of a different filename. */
 693       return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
 694     }
 695
 696   pool_get (mm->socket_files, msf);
 697   clib_memset (msf, 0, sizeof (memif_socket_file_t));
 698
 699   msf->filename = socket_filename;
 700   msf->socket_id = sock_id;
 701
 702   hash_set (mm->socket_file_index_by_sock_id, sock_id,
 703             msf - mm->socket_files);
 704
 705   return 0;
 706 }
 707
 708 static int
 709 memif_delete_socket_file (u32 sock_id)
 710 {
 711   memif_main_t *mm = &memif_main;
 712   uword *p;
 713   memif_socket_file_t *msf;
 714
 715   p = hash_get (mm->socket_file_index_by_sock_id, sock_id);
 716   if (!p)
 717     {
 718       /* Don't delete non-existent entries. */
 719       return VNET_API_ERROR_INVALID_ARGUMENT;
 720     }
 721
 722   msf = pool_elt_at_index (mm->socket_files, *p);
 723   if (msf->ref_cnt > 0)
 724     {
 725       return VNET_API_ERROR_UNEXPECTED_INTF_STATE;
 726     }
 727
 728   vec_free (msf->filename);
 729   pool_put (mm->socket_files, msf);
 730
 731   hash_unset (mm->socket_file_index_by_sock_id, sock_id);
 732
 733   return 0;
 734 }
 735
 736 int
 737 memif_socket_filename_add_del (u8 is_add, u32 sock_id, u8 * sock_filename)
 738 {
 739   char *dir = 0, *tmp;
 740   u32 idx = 0;
 741
 742   /* allow adding socket id 0 */
 743   if ((sock_id == 0 && is_add == 0) || sock_id == ~0)
 744     {
 745       return VNET_API_ERROR_INVALID_ARGUMENT;
 746     }
 747
 748   if (is_add == 0)
 749     {
 750       return memif_delete_socket_file (sock_id);
 751     }
 752
 753   if (sock_filename == 0 || sock_filename[0] == 0)
 754     {
 755       return VNET_API_ERROR_INVALID_ARGUMENT;
 756     }
 757
 758   if (sock_filename[0] != '/')
 759     {
 760       clib_error_t *error;
 761
 762       /* copy runtime dir path */
 763       vec_add (dir, vlib_unix_get_runtime_dir (),
 764                strlen (vlib_unix_get_runtime_dir ()));
 765       vec_add1 (dir, '/');
 766
 767       /* if sock_filename contains dirs, add them to path */
 768       tmp = strrchr ((char *) sock_filename, '/');
 769       if (tmp)
 770         {
 771           idx = tmp - (char *) sock_filename;
 772           vec_add (dir, sock_filename, idx);
 773         }
 774
 775       vec_add1 (dir, '\0');
 776       /* create socket dir */
 777       error = vlib_unix_recursive_mkdir (dir);
 778       if (error)
 779         {
 780           clib_error_free (error);
 781           return VNET_API_ERROR_SYSCALL_ERROR_1;
 782         }
 783
 784       sock_filename = format (0, "%s/%s%c", vlib_unix_get_runtime_dir (),
 785                               sock_filename, 0);
 786     }
 787   else
 788     {
 789       sock_filename = vec_dup (sock_filename);
 790
 791       /* check if directory exists */
 792       tmp = strrchr ((char *) sock_filename, '/');
 793       if (tmp)
 794         {
 795           idx = tmp - (char *) sock_filename;
 796           vec_add (dir, sock_filename, idx);
 797           vec_add1 (dir, '\0');
 798         }
 799
 800       /* check dir existance and access rights for effective user/group IDs */
 801       if ((dir == NULL)
 802           ||
 803           (faccessat ( /* ignored */ -1, dir, F_OK | R_OK | W_OK, AT_EACCESS)
 804            < 0))
 805         {
 806           vec_free (dir);
 807           return VNET_API_ERROR_INVALID_ARGUMENT;
 808         }
 809     }
 810   vec_free (dir);
 811
 812   return memif_add_socket_file (sock_id, sock_filename);
 813 }
 814
 815 int
 816 memif_delete_if (vlib_main_t * vm, memif_if_t * mif)
 817 {
 818   vnet_main_t *vnm = vnet_get_main ();
 819   memif_main_t *mm = &memif_main;
 820   memif_socket_file_t *msf =
 821     vec_elt_at_index (mm->socket_files, mif->socket_file_index);
 822   clib_error_t *err;
 823
 824   mif->flags |= MEMIF_IF_FLAG_DELETING;
 825   vec_free (mif->local_disc_string);
 826   vec_free (mif->remote_disc_string);
 827
 828   /* bring down the interface */
 829   vnet_hw_interface_set_flags (vnm, mif->hw_if_index, 0);
 830   vnet_sw_interface_set_flags (vnm, mif->sw_if_index, 0);
 831
 832   err = clib_error_return (0, "interface deleted");
 833   memif_disconnect (mif, err);
 834   clib_error_free (err);
 835
 836   if (mif->hw_if_index != ~0)
 837     {
 838       /* remove the interface */
 839       if (mif->mode == MEMIF_INTERFACE_MODE_IP)
 840         vnet_delete_hw_interface (vnm, mif->hw_if_index);
 841       else
 842         ethernet_delete_interface (vnm, mif->hw_if_index);
 843       mif->hw_if_index = ~0;
 844     }
 845
 846   /* free interface data structures */
 847   mhash_unset (&msf->dev_instance_by_id, &mif->id, 0);
 848
 849   /* remove socket file */
 850   if (--(msf->ref_cnt) == 0)
 851     {
 852       if (msf->is_listener)
 853         {
 854           int i;
 855           /* *INDENT-OFF* */
 856           vec_foreach_index (i, msf->pending_clients)
 857             memif_socket_close (msf->pending_clients + i);
 858           /* *INDENT-ON* */
 859           memif_socket_close (&msf->sock);
 860           vec_free (msf->pending_clients);
 861         }
 862       mhash_free (&msf->dev_instance_by_id);
 863       hash_free (msf->dev_instance_by_fd);
 864       if (msf->sock)
 865         {
 866           err = clib_socket_close (msf->sock);
 867           if (err)
 868             {
 869               memif_log_err (mif, "%U", format_clib_error, err);
 870               clib_error_free (err);
 871             }
 872           clib_mem_free (msf->sock);
 873         }
 874     }
 875
 876   clib_memset (mif, 0, sizeof (*mif));
 877   pool_put (mm->interfaces, mif);
 878
 879   if (pool_elts (mm->interfaces) == 0)
 880     vlib_process_signal_event (vm, memif_process_node.index,
 881                                MEMIF_PROCESS_EVENT_STOP, 0);
 882
 883   return 0;
 884 }
 885
 886 /* *INDENT-OFF* */
 887 VNET_HW_INTERFACE_CLASS (memif_ip_hw_if_class, static) = {
 888   .name = "memif-ip",
 889   .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
 890   .tx_hash_fn_type = VNET_HASH_FN_TYPE_IP,
 891 };
 892 /* *INDENT-ON* */
 893
 894 int
 895 memif_create_if (vlib_main_t * vm, memif_create_if_args_t * args)
 896 {
 897   memif_main_t *mm = &memif_main;
 898   vlib_thread_main_t *tm = vlib_get_thread_main ();
 899   vnet_main_t *vnm = vnet_get_main ();
 900   vnet_eth_interface_registration_t eir = {};
 901   memif_if_t *mif = 0;
 902   vnet_sw_interface_t *sw;
 903   clib_error_t *error = 0;
 904   int ret = 0;
 905   uword *p;
 906   memif_socket_file_t *msf = 0;
 907   int rv = 0;
 908
 909   p = hash_get (mm->socket_file_index_by_sock_id, args->socket_id);
 910   if (p == 0)
 911     {
 912       rv = VNET_API_ERROR_INVALID_ARGUMENT;
 913       goto done;
 914     }
 915
 916   msf = vec_elt_at_index (mm->socket_files, p[0]);
 917
 918   /* existing socket file can be either master or slave but cannot be both */
 919   if (msf->ref_cnt > 0)
 920     {
 921       if ((!msf->is_listener != !args->is_master))
 922         {
 923           rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
 924           goto done;
 925         }
 926
 927       p = mhash_get (&msf->dev_instance_by_id, &args->id);
 928       if (p)
 929         {
 930           rv = VNET_API_ERROR_SUBIF_ALREADY_EXISTS;
 931           goto done;
 932         }
 933     }
 934
 935   /* Create new socket file */
 936   if (msf->ref_cnt == 0)
 937     {
 938       struct stat file_stat;
 939
 940       /* If we are creating listener make sure file doesn't exist or if it
 941        * exists thn delete it if it is old socket file */
 942       if (args->is_master && (stat ((char *) msf->filename, &file_stat) == 0))
 943         {
 944           if (S_ISSOCK (file_stat.st_mode))
 945             {
 946               unlink ((char *) msf->filename);
 947             }
 948           else
 949             {
 950               error = clib_error_return (0, "File exists for %s",
 951                                          msf->filename);
 952               rv = VNET_API_ERROR_VALUE_EXIST;
 953               goto done;
 954             }
 955         }
 956
 957       mhash_init (&msf->dev_instance_by_id, sizeof (uword),
 958                   sizeof (memif_interface_id_t));
 959       msf->dev_instance_by_fd = hash_create (0, sizeof (uword));
 960       msf->is_listener = (args->is_master != 0);
 961
 962       memif_log_debug (0, "initializing socket file %s", msf->filename);
 963     }
 964
 965   if (mm->per_thread_data == 0)
 966     {
 967       int i;
 968
 969       vec_validate_aligned (mm->per_thread_data, tm->n_vlib_mains - 1,
 970                             CLIB_CACHE_LINE_BYTES);
 971
 972       for (i = 0; i < tm->n_vlib_mains; i++)
 973         {
 974           memif_per_thread_data_t *ptd =
 975             vec_elt_at_index (mm->per_thread_data, i);
 976           vlib_buffer_t *bt = &ptd->buffer_template;
 977           clib_memset (bt, 0, sizeof (vlib_buffer_t));
 978           bt->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
 979           bt->total_length_not_including_first_buffer = 0;
 980           vnet_buffer (bt)->sw_if_index[VLIB_TX] = (u32) ~ 0;
 981
 982           /* initially prealloc copy_ops so we can use
 983              _vec_len instead of vec_elen */
 984           vec_validate_aligned (ptd->copy_ops, 0, CLIB_CACHE_LINE_BYTES);
 985           vec_reset_length (ptd->copy_ops);
 986           vec_validate_aligned (ptd->buffers, 0, CLIB_CACHE_LINE_BYTES);
 987           vec_reset_length (ptd->buffers);
 988         }
 989     }
 990
 991   pool_get (mm->interfaces, mif);
 992   clib_memset (mif, 0, sizeof (*mif));
 993   mif->dev_instance = mif - mm->interfaces;
 994   mif->socket_file_index = msf - mm->socket_files;
 995   mif->id = args->id;
 996   mif->sw_if_index = mif->hw_if_index = mif->per_interface_next_index = ~0;
 997   mif->mode = args->mode;
 998   if (args->secret)
 999     mif->secret = vec_dup (args->secret);
1000
1001   if (mif->mode == MEMIF_INTERFACE_MODE_ETHERNET)
1002     {
1003
1004       if (!args->hw_addr_set)
1005         {
1006           f64 now = vlib_time_now (vm);
1007           u32 rnd;
1008           rnd = (u32) (now * 1e6);
1009           rnd = random_u32 (&rnd);
1010
1011           memcpy (args->hw_addr + 2, &rnd, sizeof (rnd));
1012           args->hw_addr[0] = 2;
1013           args->hw_addr[1] = 0xfe;
1014         }
1015
1016       eir.dev_class_index = memif_device_class.index;
1017       eir.dev_instance = mif->dev_instance;
1018       eir.address = args->hw_addr;
1019       eir.cb.flag_change = memif_eth_flag_change;
1020       mif->hw_if_index = vnet_eth_register_interface (vnm, &eir);
1021     }
1022   else if (mif->mode == MEMIF_INTERFACE_MODE_IP)
1023     {
1024       mif->hw_if_index =
1025         vnet_register_interface (vnm, memif_device_class.index,
1026                                  mif->dev_instance,
1027                                  memif_ip_hw_if_class.index,
1028                                  mif->dev_instance);
1029     }
1030   else
1031     error = clib_error_return (0, "unsupported interface mode");
1032
1033   if (error)
1034     {
1035       ret = VNET_API_ERROR_SYSCALL_ERROR_2;
1036       goto error;
1037     }
1038
1039   sw = vnet_get_hw_sw_interface (vnm, mif->hw_if_index);
1040   mif->sw_if_index = sw->sw_if_index;
1041
1042   mif->cfg.log2_ring_size = args->log2_ring_size;
1043   mif->cfg.buffer_size = args->buffer_size;
1044   mif->cfg.num_s2m_rings =
1045     args->is_master ? args->rx_queues : args->tx_queues;
1046   mif->cfg.num_m2s_rings =
1047     args->is_master ? args->tx_queues : args->rx_queues;
1048
1049   args->sw_if_index = mif->sw_if_index;
1050
1051   /* If this is new one, start listening */
1052   if (msf->is_listener && msf->ref_cnt == 0)
1053     {
1054       struct stat file_stat;
1055       clib_socket_t *s = clib_mem_alloc (sizeof (clib_socket_t));
1056
1057       ASSERT (msf->sock == 0);
1058       msf->sock = s;
1059
1060       clib_memset (s, 0, sizeof (clib_socket_t));
1061       s->config = (char *) msf->filename;
1062       s->flags = CLIB_SOCKET_F_IS_SERVER |
1063         CLIB_SOCKET_F_ALLOW_GROUP_WRITE |
1064         CLIB_SOCKET_F_SEQPACKET | CLIB_SOCKET_F_PASSCRED;
1065
1066       if ((error = clib_socket_init (s)))
1067         {
1068           ret = VNET_API_ERROR_SYSCALL_ERROR_4;
1069           goto error;
1070         }
1071
1072       if (stat ((char *) msf->filename, &file_stat) == -1)
1073         {
1074           ret = VNET_API_ERROR_SYSCALL_ERROR_8;
1075           goto error;
1076         }
1077
1078       clib_file_t template = { 0 };
1079       template.read_function = memif_conn_fd_accept_ready;
1080       template.file_descriptor = msf->sock->fd;
1081       template.private_data = mif->socket_file_index;
1082       template.description = format (0, "memif listener %s", msf->filename);
1083       memif_file_add (&msf->sock->private_data, &template);
1084     }
1085
1086   msf->ref_cnt++;
1087
1088   if (args->is_master == 0)
1089     {
1090       mif->flags |= MEMIF_IF_FLAG_IS_SLAVE;
1091       if (args->is_zero_copy)
1092         mif->flags |= MEMIF_IF_FLAG_ZERO_COPY;
1093     }
1094
1095   vnet_hw_if_set_caps (vnm, mif->hw_if_index, VNET_HW_IF_CAP_INT_MODE);
1096   vnet_hw_if_set_input_node (vnm, mif->hw_if_index, memif_input_node.index);
1097   mhash_set (&msf->dev_instance_by_id, &mif->id, mif->dev_instance, 0);
1098
1099   if (pool_elts (mm->interfaces) == 1)
1100     {
1101       vlib_process_signal_event (vm, memif_process_node.index,
1102                                  MEMIF_PROCESS_EVENT_START, 0);
1103     }
1104   goto done;
1105
1106 error:
1107   memif_delete_if (vm, mif);
1108   if (error)
1109     {
1110       memif_log_err (mif, "%U", format_clib_error, error);
1111       clib_error_free (error);
1112     }
1113   return ret;
1114
1115 done:
1116   return rv;
1117 }
1118
1119 clib_error_t *
1120 memif_interface_admin_up_down (vnet_main_t *vnm, u32 hw_if_index, u32 flags)
1121 {
1122   memif_main_t *mm = &memif_main;
1123   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
1124   memif_if_t *mif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
1125   static clib_error_t *error = 0;
1126
1127   if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1128     {
1129       if (mif->flags & MEMIF_IF_FLAG_CONNECTED)
1130         {
1131           vnet_hw_interface_set_flags (vnm, mif->hw_if_index,
1132                                        VNET_HW_INTERFACE_FLAG_LINK_UP);
1133         }
1134       mif->flags |= MEMIF_IF_FLAG_ADMIN_UP;
1135     }
1136   else
1137     mif->flags &= ~MEMIF_IF_FLAG_ADMIN_UP;
1138
1139   vlib_process_signal_event (vnm->vlib_main, memif_process_node.index,
1140                              MEMIF_PROCESS_EVENT_ADMIN_UP_DOWN, 0);
1141   return error;
1142 }
1143
1144 static clib_error_t *
1145 memif_init (vlib_main_t * vm)
1146 {
1147   memif_main_t *mm = &memif_main;
1148
1149   clib_memset (mm, 0, sizeof (memif_main_t));
1150
1151   mm->log_class = vlib_log_register_class ("memif_plugin", 0);
1152   memif_log_debug (0, "initialized");
1153
1154   /* initialize binary API */
1155   memif_plugin_api_hookup (vm);
1156
1157   /*
1158    * Pre-stuff socket filename pool with a non-modifieable mapping
1159    * for socket-id 0 to MEMIF_DEFAULT_SOCKET_FILENAME in the
1160    * default run-time directory.
1161    */
1162   memif_socket_filename_add_del (1, 0, (u8 *) MEMIF_DEFAULT_SOCKET_FILENAME);
1163
1164   return 0;
1165 }
1166
1167 VLIB_INIT_FUNCTION (memif_init);
1168
1169 /* *INDENT-OFF* */
1170 VLIB_PLUGIN_REGISTER () = {
1171     .version = VPP_BUILD_VER,
1172     .description = "Packet Memory Interface (memif) -- Experimental",
1173 };
1174 /* *INDENT-ON* */
1175
1176 /*
1177  * fd.io coding-style-patch-verification: ON
1178  *
1179  * Local Variables:
1180  * eval: (c-set-style "gnu")
1181  * End:
1182  */