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