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