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