src/plugins/memif/memif.c

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