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