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