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