drivers/misc/vmw_vmci/vmci_host.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * VMware VMCI Driver
   4  *
   5  * Copyright (C) 2012 VMware, Inc. All rights reserved.
   6  */
   7
   8 #include <linux/vmw_vmci_defs.h>
   9 #include <linux/vmw_vmci_api.h>
  10 #include <linux/miscdevice.h>
  11 #include <linux/interrupt.h>
  12 #include <linux/highmem.h>
  13 #include <linux/atomic.h>
  14 #include <linux/kernel.h>
  15 #include <linux/module.h>
  16 #include <linux/mutex.h>
  17 #include <linux/sched.h>
  18 #include <linux/cred.h>
  19 #include <linux/slab.h>
  20 #include <linux/file.h>
  21 #include <linux/init.h>
  22 #include <linux/poll.h>
  23 #include <linux/pci.h>
  24 #include <linux/smp.h>
  25 #include <linux/fs.h>
  26 #include <linux/io.h>
  27
  28 #include "vmci_handle_array.h"
  29 #include "vmci_queue_pair.h"
  30 #include "vmci_datagram.h"
  31 #include "vmci_doorbell.h"
  32 #include "vmci_resource.h"
  33 #include "vmci_context.h"
  34 #include "vmci_driver.h"
  35 #include "vmci_event.h"
  36
  37 #define VMCI_UTIL_NUM_RESOURCES 1
  38
  39 enum {
  40         VMCI_NOTIFY_RESOURCE_QUEUE_PAIR = 0,
  41         VMCI_NOTIFY_RESOURCE_DOOR_BELL = 1,
  42 };
  43
  44 enum {
  45         VMCI_NOTIFY_RESOURCE_ACTION_NOTIFY = 0,
  46         VMCI_NOTIFY_RESOURCE_ACTION_CREATE = 1,
  47         VMCI_NOTIFY_RESOURCE_ACTION_DESTROY = 2,
  48 };
  49
  50 /*
  51  * VMCI driver initialization. This block can also be used to
  52  * pass initial group membership etc.
  53  */
  54 struct vmci_init_blk {
  55         u32 cid;
  56         u32 flags;
  57 };
  58
  59 /* VMCIqueue_pairAllocInfo_VMToVM */
  60 struct vmci_qp_alloc_info_vmvm {
  61         struct vmci_handle handle;
  62         u32 peer;
  63         u32 flags;
  64         u64 produce_size;
  65         u64 consume_size;
  66         u64 produce_page_file;    /* User VA. */
  67         u64 consume_page_file;    /* User VA. */
  68         u64 produce_page_file_size;  /* Size of the file name array. */
  69         u64 consume_page_file_size;  /* Size of the file name array. */
  70         s32 result;
  71         u32 _pad;
  72 };
  73
  74 /* VMCISetNotifyInfo: Used to pass notify flag's address to the host driver. */
  75 struct vmci_set_notify_info {
  76         u64 notify_uva;
  77         s32 result;
  78         u32 _pad;
  79 };
  80
  81 /*
  82  * Per-instance host state
  83  */
  84 struct vmci_host_dev {
  85         struct vmci_ctx *context;
  86         int user_version;
  87         enum vmci_obj_type ct_type;
  88         struct mutex lock;  /* Mutex lock for vmci context access */
  89 };
  90
  91 static struct vmci_ctx *host_context;
  92 static bool vmci_host_device_initialized;
  93 static atomic_t vmci_host_active_users = ATOMIC_INIT(0);
  94
  95 /*
  96  * Determines whether the VMCI host personality is
  97  * available. Since the core functionality of the host driver is
  98  * always present, all guests could possibly use the host
  99  * personality. However, to minimize the deviation from the
 100  * pre-unified driver state of affairs, we only consider the host
 101  * device active if there is no active guest device or if there
 102  * are VMX'en with active VMCI contexts using the host device.
 103  */
 104 bool vmci_host_code_active(void)
 105 {
 106         return vmci_host_device_initialized &&
 107             (!vmci_guest_code_active() ||
 108              atomic_read(&vmci_host_active_users) > 0);
 109 }
 110
 111 int vmci_host_users(void)
 112 {
 113         return atomic_read(&vmci_host_active_users);
 114 }
 115
 116 /*
 117  * Called on open of /dev/vmci.
 118  */
 119 static int vmci_host_open(struct inode *inode, struct file *filp)
 120 {
 121         struct vmci_host_dev *vmci_host_dev;
 122
 123         vmci_host_dev = kzalloc(sizeof(struct vmci_host_dev), GFP_KERNEL);
 124         if (vmci_host_dev == NULL)
 125                 return -ENOMEM;
 126
 127         vmci_host_dev->ct_type = VMCIOBJ_NOT_SET;
 128         mutex_init(&vmci_host_dev->lock);
 129         filp->private_data = vmci_host_dev;
 130
 131         return 0;
 132 }
 133
 134 /*
 135  * Called on close of /dev/vmci, most often when the process
 136  * exits.
 137  */
 138 static int vmci_host_close(struct inode *inode, struct file *filp)
 139 {
 140         struct vmci_host_dev *vmci_host_dev = filp->private_data;
 141
 142         if (vmci_host_dev->ct_type == VMCIOBJ_CONTEXT) {
 143                 vmci_ctx_destroy(vmci_host_dev->context);
 144                 vmci_host_dev->context = NULL;
 145
 146                 /*
 147                  * The number of active contexts is used to track whether any
 148                  * VMX'en are using the host personality. It is incremented when
 149                  * a context is created through the IOCTL_VMCI_INIT_CONTEXT
 150                  * ioctl.
 151                  */
 152                 atomic_dec(&vmci_host_active_users);
 153         }
 154         vmci_host_dev->ct_type = VMCIOBJ_NOT_SET;
 155
 156         kfree(vmci_host_dev);
 157         filp->private_data = NULL;
 158         return 0;
 159 }
 160
 161 /*
 162  * This is used to wake up the VMX when a VMCI call arrives, or
 163  * to wake up select() or poll() at the next clock tick.
 164  */
 165 static __poll_t vmci_host_poll(struct file *filp, poll_table *wait)
 166 {
 167         struct vmci_host_dev *vmci_host_dev = filp->private_data;
 168         struct vmci_ctx *context;
 169         __poll_t mask = 0;
 170
 171         if (vmci_host_dev->ct_type == VMCIOBJ_CONTEXT) {
 172                 /*
 173                  * Read context only if ct_type == VMCIOBJ_CONTEXT to make
 174                  * sure that context is initialized
 175                  */
 176                 context = vmci_host_dev->context;
 177
 178                 /* Check for VMCI calls to this VM context. */
 179                 if (wait)
 180                         poll_wait(filp, &context->host_context.wait_queue,
 181                                   wait);
 182
 183                 spin_lock(&context->lock);
 184                 if (context->pending_datagrams > 0 ||
 185                     vmci_handle_arr_get_size(
 186                                 context->pending_doorbell_array) > 0) {
 187                         mask = EPOLLIN;
 188                 }
 189                 spin_unlock(&context->lock);
 190         }
 191         return mask;
 192 }
 193
 194 /*
 195  * Copies the handles of a handle array into a user buffer, and
 196  * returns the new length in userBufferSize. If the copy to the
 197  * user buffer fails, the functions still returns VMCI_SUCCESS,
 198  * but retval != 0.
 199  */
 200 static int drv_cp_harray_to_user(void __user *user_buf_uva,
 201                                  u64 *user_buf_size,
 202                                  struct vmci_handle_arr *handle_array,
 203                                  int *retval)
 204 {
 205         u32 array_size = 0;
 206         struct vmci_handle *handles;
 207
 208         if (handle_array)
 209                 array_size = vmci_handle_arr_get_size(handle_array);
 210
 211         if (array_size * sizeof(*handles) > *user_buf_size)
 212                 return VMCI_ERROR_MORE_DATA;
 213
 214         *user_buf_size = array_size * sizeof(*handles);
 215         if (*user_buf_size)
 216                 *retval = copy_to_user(user_buf_uva,
 217                                        vmci_handle_arr_get_handles
 218                                        (handle_array), *user_buf_size);
 219
 220         return VMCI_SUCCESS;
 221 }
 222
 223 /*
 224  * Sets up a given context for notify to work. Maps the notify
 225  * boolean in user VA into kernel space.
 226  */
 227 static int vmci_host_setup_notify(struct vmci_ctx *context,
 228                                   unsigned long uva)
 229 {
 230         int retval;
 231
 232         if (context->notify_page) {
 233                 pr_devel("%s: Notify mechanism is already set up\n", __func__);
 234                 return VMCI_ERROR_DUPLICATE_ENTRY;
 235         }
 236
 237         /*
 238          * We are using 'bool' internally, but let's make sure we explicit
 239          * about the size.
 240          */
 241         BUILD_BUG_ON(sizeof(bool) != sizeof(u8));
 242
 243         /*
 244          * Lock physical page backing a given user VA.
 245          */
 246         retval = get_user_pages_fast(uva, 1, FOLL_WRITE, &context->notify_page);
 247         if (retval != 1) {
 248                 context->notify_page = NULL;
 249                 return VMCI_ERROR_GENERIC;
 250         }
 251
 252         /*
 253          * Map the locked page and set up notify pointer.
 254          */
 255         context->notify = kmap(context->notify_page) + (uva & (PAGE_SIZE - 1));
 256         vmci_ctx_check_signal_notify(context);
 257
 258         return VMCI_SUCCESS;
 259 }
 260
 261 static int vmci_host_get_version(struct vmci_host_dev *vmci_host_dev,
 262                                  unsigned int cmd, void __user *uptr)
 263 {
 264         if (cmd == IOCTL_VMCI_VERSION2) {
 265                 int __user *vptr = uptr;
 266                 if (get_user(vmci_host_dev->user_version, vptr))
 267                         return -EFAULT;
 268         }
 269
 270         /*
 271          * The basic logic here is:
 272          *
 273          * If the user sends in a version of 0 tell it our version.
 274          * If the user didn't send in a version, tell it our version.
 275          * If the user sent in an old version, tell it -its- version.
 276          * If the user sent in an newer version, tell it our version.
 277          *
 278          * The rationale behind telling the caller its version is that
 279          * Workstation 6.5 required that VMX and VMCI kernel module were
 280          * version sync'd.  All new VMX users will be programmed to
 281          * handle the VMCI kernel module version.
 282          */
 283
 284         if (vmci_host_dev->user_version > 0 &&
 285             vmci_host_dev->user_version < VMCI_VERSION_HOSTQP) {
 286                 return vmci_host_dev->user_version;
 287         }
 288
 289         return VMCI_VERSION;
 290 }
 291
 292 #define vmci_ioctl_err(fmt, ...)        \
 293         pr_devel("%s: " fmt, ioctl_name, ##__VA_ARGS__)
 294
 295 static int vmci_host_do_init_context(struct vmci_host_dev *vmci_host_dev,
 296                                      const char *ioctl_name,
 297                                      void __user *uptr)
 298 {
 299         struct vmci_init_blk init_block;
 300         const struct cred *cred;
 301         int retval;
 302
 303         if (copy_from_user(&init_block, uptr, sizeof(init_block))) {
 304                 vmci_ioctl_err("error reading init block\n");
 305                 return -EFAULT;
 306         }
 307
 308         mutex_lock(&vmci_host_dev->lock);
 309
 310         if (vmci_host_dev->ct_type != VMCIOBJ_NOT_SET) {
 311                 vmci_ioctl_err("received VMCI init on initialized handle\n");
 312                 retval = -EINVAL;
 313                 goto out;
 314         }
 315
 316         if (init_block.flags & ~VMCI_PRIVILEGE_FLAG_RESTRICTED) {
 317                 vmci_ioctl_err("unsupported VMCI restriction flag\n");
 318                 retval = -EINVAL;
 319                 goto out;
 320         }
 321
 322         cred = get_current_cred();
 323         vmci_host_dev->context = vmci_ctx_create(init_block.cid,
 324                                                  init_block.flags, 0,
 325                                                  vmci_host_dev->user_version,
 326                                                  cred);
 327         put_cred(cred);
 328         if (IS_ERR(vmci_host_dev->context)) {
 329                 retval = PTR_ERR(vmci_host_dev->context);
 330                 vmci_ioctl_err("error initializing context\n");
 331                 goto out;
 332         }
 333
 334         /*
 335          * Copy cid to userlevel, we do this to allow the VMX
 336          * to enforce its policy on cid generation.
 337          */
 338         init_block.cid = vmci_ctx_get_id(vmci_host_dev->context);
 339         if (copy_to_user(uptr, &init_block, sizeof(init_block))) {
 340                 vmci_ctx_destroy(vmci_host_dev->context);
 341                 vmci_host_dev->context = NULL;
 342                 vmci_ioctl_err("error writing init block\n");
 343                 retval = -EFAULT;
 344                 goto out;
 345         }
 346
 347         vmci_host_dev->ct_type = VMCIOBJ_CONTEXT;
 348         atomic_inc(&vmci_host_active_users);
 349
 350         vmci_call_vsock_callback(true);
 351
 352         retval = 0;
 353
 354 out:
 355         mutex_unlock(&vmci_host_dev->lock);
 356         return retval;
 357 }
 358
 359 static int vmci_host_do_send_datagram(struct vmci_host_dev *vmci_host_dev,
 360                                       const char *ioctl_name,
 361                                       void __user *uptr)
 362 {
 363         struct vmci_datagram_snd_rcv_info send_info;
 364         struct vmci_datagram *dg = NULL;
 365         u32 cid;
 366
 367         if (vmci_host_dev->ct_type != VMCIOBJ_CONTEXT) {
 368                 vmci_ioctl_err("only valid for contexts\n");
 369                 return -EINVAL;
 370         }
 371
 372         if (copy_from_user(&send_info, uptr, sizeof(send_info)))
 373                 return -EFAULT;
 374
 375         if (send_info.len > VMCI_MAX_DG_SIZE) {
 376                 vmci_ioctl_err("datagram is too big (size=%d)\n",
 377                                send_info.len);
 378                 return -EINVAL;
 379         }
 380
 381         if (send_info.len < sizeof(*dg)) {
 382                 vmci_ioctl_err("datagram is too small (size=%d)\n",
 383                                send_info.len);
 384                 return -EINVAL;
 385         }
 386
 387         dg = memdup_user((void __user *)(uintptr_t)send_info.addr,
 388                          send_info.len);
 389         if (IS_ERR(dg)) {
 390                 vmci_ioctl_err(
 391                         "cannot allocate memory to dispatch datagram\n");
 392                 return PTR_ERR(dg);
 393         }
 394
 395         if (VMCI_DG_SIZE(dg) != send_info.len) {
 396                 vmci_ioctl_err("datagram size mismatch\n");
 397                 kfree(dg);
 398                 return -EINVAL;
 399         }
 400
 401         pr_devel("Datagram dst (handle=0x%x:0x%x) src (handle=0x%x:0x%x), payload (size=%llu bytes)\n",
 402                  dg->dst.context, dg->dst.resource,
 403                  dg->src.context, dg->src.resource,
 404                  (unsigned long long)dg->payload_size);
 405
 406         /* Get source context id. */
 407         cid = vmci_ctx_get_id(vmci_host_dev->context);
 408         send_info.result = vmci_datagram_dispatch(cid, dg, true);
 409         kfree(dg);
 410
 411         return copy_to_user(uptr, &send_info, sizeof(send_info)) ? -EFAULT : 0;
 412 }
 413
 414 static int vmci_host_do_receive_datagram(struct vmci_host_dev *vmci_host_dev,
 415                                          const char *ioctl_name,
 416                                          void __user *uptr)
 417 {
 418         struct vmci_datagram_snd_rcv_info recv_info;
 419         struct vmci_datagram *dg = NULL;
 420         int retval;
 421         size_t size;
 422
 423         if (vmci_host_dev->ct_type != VMCIOBJ_CONTEXT) {
 424                 vmci_ioctl_err("only valid for contexts\n");
 425                 return -EINVAL;
 426         }
 427
 428         if (copy_from_user(&recv_info, uptr, sizeof(recv_info)))
 429                 return -EFAULT;
 430
 431         size = recv_info.len;
 432         recv_info.result = vmci_ctx_dequeue_datagram(vmci_host_dev->context,
 433                                                      &size, &dg);
 434
 435         if (recv_info.result >= VMCI_SUCCESS) {
 436                 void __user *ubuf = (void __user *)(uintptr_t)recv_info.addr;
 437                 retval = copy_to_user(ubuf, dg, VMCI_DG_SIZE(dg));
 438                 kfree(dg);
 439                 if (retval != 0)
 440                         return -EFAULT;
 441         }
 442
 443         return copy_to_user(uptr, &recv_info, sizeof(recv_info)) ? -EFAULT : 0;
 444 }
 445
 446 static int vmci_host_do_alloc_queuepair(struct vmci_host_dev *vmci_host_dev,
 447                                         const char *ioctl_name,
 448                                         void __user *uptr)
 449 {
 450         struct vmci_handle handle;
 451         int vmci_status;
 452         int __user *retptr;
 453
 454         if (vmci_host_dev->ct_type != VMCIOBJ_CONTEXT) {
 455                 vmci_ioctl_err("only valid for contexts\n");
 456                 return -EINVAL;
 457         }
 458
 459         if (vmci_host_dev->user_version < VMCI_VERSION_NOVMVM) {
 460                 struct vmci_qp_alloc_info_vmvm alloc_info;
 461                 struct vmci_qp_alloc_info_vmvm __user *info = uptr;
 462
 463                 if (copy_from_user(&alloc_info, uptr, sizeof(alloc_info)))
 464                         return -EFAULT;
 465
 466                 handle = alloc_info.handle;
 467                 retptr = &info->result;
 468
 469                 vmci_status = vmci_qp_broker_alloc(alloc_info.handle,
 470                                                 alloc_info.peer,
 471                                                 alloc_info.flags,
 472                                                 VMCI_NO_PRIVILEGE_FLAGS,
 473                                                 alloc_info.produce_size,
 474                                                 alloc_info.consume_size,
 475                                                 NULL,
 476                                                 vmci_host_dev->context);
 477
 478                 if (vmci_status == VMCI_SUCCESS)
 479                         vmci_status = VMCI_SUCCESS_QUEUEPAIR_CREATE;
 480         } else {
 481                 struct vmci_qp_alloc_info alloc_info;
 482                 struct vmci_qp_alloc_info __user *info = uptr;
 483                 struct vmci_qp_page_store page_store;
 484
 485                 if (copy_from_user(&alloc_info, uptr, sizeof(alloc_info)))
 486                         return -EFAULT;
 487
 488                 handle = alloc_info.handle;
 489                 retptr = &info->result;
 490
 491                 page_store.pages = alloc_info.ppn_va;
 492                 page_store.len = alloc_info.num_ppns;
 493
 494                 vmci_status = vmci_qp_broker_alloc(alloc_info.handle,
 495                                                 alloc_info.peer,
 496                                                 alloc_info.flags,
 497                                                 VMCI_NO_PRIVILEGE_FLAGS,
 498                                                 alloc_info.produce_size,
 499                                                 alloc_info.consume_size,
 500                                                 &page_store,
 501                                                 vmci_host_dev->context);
 502         }
 503
 504         if (put_user(vmci_status, retptr)) {
 505                 if (vmci_status >= VMCI_SUCCESS) {
 506                         vmci_status = vmci_qp_broker_detach(handle,
 507                                                         vmci_host_dev->context);
 508                 }
 509                 return -EFAULT;
 510         }
 511
 512         return 0;
 513 }
 514
 515 static int vmci_host_do_queuepair_setva(struct vmci_host_dev *vmci_host_dev,
 516                                         const char *ioctl_name,
 517                                         void __user *uptr)
 518 {
 519         struct vmci_qp_set_va_info set_va_info;
 520         struct vmci_qp_set_va_info __user *info = uptr;
 521         s32 result;
 522
 523         if (vmci_host_dev->ct_type != VMCIOBJ_CONTEXT) {
 524                 vmci_ioctl_err("only valid for contexts\n");
 525                 return -EINVAL;
 526         }
 527
 528         if (vmci_host_dev->user_version < VMCI_VERSION_NOVMVM) {
 529                 vmci_ioctl_err("is not allowed\n");
 530                 return -EINVAL;
 531         }
 532
 533         if (copy_from_user(&set_va_info, uptr, sizeof(set_va_info)))
 534                 return -EFAULT;
 535
 536         if (set_va_info.va) {
 537                 /*
 538                  * VMX is passing down a new VA for the queue
 539                  * pair mapping.
 540                  */
 541                 result = vmci_qp_broker_map(set_va_info.handle,
 542                                             vmci_host_dev->context,
 543                                             set_va_info.va);
 544         } else {
 545                 /*
 546                  * The queue pair is about to be unmapped by
 547                  * the VMX.
 548                  */
 549                 result = vmci_qp_broker_unmap(set_va_info.handle,
 550                                          vmci_host_dev->context, 0);
 551         }
 552
 553         return put_user(result, &info->result) ? -EFAULT : 0;
 554 }
 555
 556 static int vmci_host_do_queuepair_setpf(struct vmci_host_dev *vmci_host_dev,
 557                                         const char *ioctl_name,
 558                                         void __user *uptr)
 559 {
 560         struct vmci_qp_page_file_info page_file_info;
 561         struct vmci_qp_page_file_info __user *info = uptr;
 562         s32 result;
 563
 564         if (vmci_host_dev->user_version < VMCI_VERSION_HOSTQP ||
 565             vmci_host_dev->user_version >= VMCI_VERSION_NOVMVM) {
 566                 vmci_ioctl_err("not supported on this VMX (version=%d)\n",
 567                                vmci_host_dev->user_version);
 568                 return -EINVAL;
 569         }
 570
 571         if (vmci_host_dev->ct_type != VMCIOBJ_CONTEXT) {
 572                 vmci_ioctl_err("only valid for contexts\n");
 573                 return -EINVAL;
 574         }
 575
 576         if (copy_from_user(&page_file_info, uptr, sizeof(*info)))
 577                 return -EFAULT;
 578
 579         /*
 580          * Communicate success pre-emptively to the caller.  Note that the
 581          * basic premise is that it is incumbent upon the caller not to look at
 582          * the info.result field until after the ioctl() returns.  And then,
 583          * only if the ioctl() result indicates no error.  We send up the
 584          * SUCCESS status before calling SetPageStore() store because failing
 585          * to copy up the result code means unwinding the SetPageStore().
 586          *
 587          * It turns out the logic to unwind a SetPageStore() opens a can of
 588          * worms.  For example, if a host had created the queue_pair and a
 589          * guest attaches and SetPageStore() is successful but writing success
 590          * fails, then ... the host has to be stopped from writing (anymore)
 591          * data into the queue_pair.  That means an additional test in the
 592          * VMCI_Enqueue() code path.  Ugh.
 593          */
 594
 595         if (put_user(VMCI_SUCCESS, &info->result)) {
 596                 /*
 597                  * In this case, we can't write a result field of the
 598                  * caller's info block.  So, we don't even try to
 599                  * SetPageStore().
 600                  */
 601                 return -EFAULT;
 602         }
 603
 604         result = vmci_qp_broker_set_page_store(page_file_info.handle,
 605                                                 page_file_info.produce_va,
 606                                                 page_file_info.consume_va,
 607                                                 vmci_host_dev->context);
 608         if (result < VMCI_SUCCESS) {
 609                 if (put_user(result, &info->result)) {
 610                         /*
 611                          * Note that in this case the SetPageStore()
 612                          * call failed but we were unable to
 613                          * communicate that to the caller (because the
 614                          * copy_to_user() call failed).  So, if we
 615                          * simply return an error (in this case
 616                          * -EFAULT) then the caller will know that the
 617                          *  SetPageStore failed even though we couldn't
 618                          *  put the result code in the result field and
 619                          *  indicate exactly why it failed.
 620                          *
 621                          * That says nothing about the issue where we
 622                          * were once able to write to the caller's info
 623                          * memory and now can't.  Something more
 624                          * serious is probably going on than the fact
 625                          * that SetPageStore() didn't work.
 626                          */
 627                         return -EFAULT;
 628                 }
 629         }
 630
 631         return 0;
 632 }
 633
 634 static int vmci_host_do_qp_detach(struct vmci_host_dev *vmci_host_dev,
 635                                   const char *ioctl_name,
 636                                   void __user *uptr)
 637 {
 638         struct vmci_qp_dtch_info detach_info;
 639         struct vmci_qp_dtch_info __user *info = uptr;
 640         s32 result;
 641
 642         if (vmci_host_dev->ct_type != VMCIOBJ_CONTEXT) {
 643                 vmci_ioctl_err("only valid for contexts\n");
 644                 return -EINVAL;
 645         }
 646
 647         if (copy_from_user(&detach_info, uptr, sizeof(detach_info)))
 648                 return -EFAULT;
 649
 650         result = vmci_qp_broker_detach(detach_info.handle,
 651                                        vmci_host_dev->context);
 652         if (result == VMCI_SUCCESS &&
 653             vmci_host_dev->user_version < VMCI_VERSION_NOVMVM) {
 654                 result = VMCI_SUCCESS_LAST_DETACH;
 655         }
 656
 657         return put_user(result, &info->result) ? -EFAULT : 0;
 658 }
 659
 660 static int vmci_host_do_ctx_add_notify(struct vmci_host_dev *vmci_host_dev,
 661                                        const char *ioctl_name,
 662                                        void __user *uptr)
 663 {
 664         struct vmci_ctx_info ar_info;
 665         struct vmci_ctx_info __user *info = uptr;
 666         s32 result;
 667         u32 cid;
 668
 669         if (vmci_host_dev->ct_type != VMCIOBJ_CONTEXT) {
 670                 vmci_ioctl_err("only valid for contexts\n");
 671                 return -EINVAL;
 672         }
 673
 674         if (copy_from_user(&ar_info, uptr, sizeof(ar_info)))
 675                 return -EFAULT;
 676
 677         cid = vmci_ctx_get_id(vmci_host_dev->context);
 678         result = vmci_ctx_add_notification(cid, ar_info.remote_cid);
 679
 680         return put_user(result, &info->result) ? -EFAULT : 0;
 681 }
 682
 683 static int vmci_host_do_ctx_remove_notify(struct vmci_host_dev *vmci_host_dev,
 684                                           const char *ioctl_name,
 685                                           void __user *uptr)
 686 {
 687         struct vmci_ctx_info ar_info;
 688         struct vmci_ctx_info __user *info = uptr;
 689         u32 cid;
 690         int result;
 691
 692         if (vmci_host_dev->ct_type != VMCIOBJ_CONTEXT) {
 693                 vmci_ioctl_err("only valid for contexts\n");
 694                 return -EINVAL;
 695         }
 696
 697         if (copy_from_user(&ar_info, uptr, sizeof(ar_info)))
 698                 return -EFAULT;
 699
 700         cid = vmci_ctx_get_id(vmci_host_dev->context);
 701         result = vmci_ctx_remove_notification(cid,
 702                                               ar_info.remote_cid);
 703
 704         return put_user(result, &info->result) ? -EFAULT : 0;
 705 }
 706
 707 static int vmci_host_do_ctx_get_cpt_state(struct vmci_host_dev *vmci_host_dev,
 708                                           const char *ioctl_name,
 709                                           void __user *uptr)
 710 {
 711         struct vmci_ctx_chkpt_buf_info get_info;
 712         u32 cid;
 713         void *cpt_buf;
 714         int retval;
 715
 716         if (vmci_host_dev->ct_type != VMCIOBJ_CONTEXT) {
 717                 vmci_ioctl_err("only valid for contexts\n");
 718                 return -EINVAL;
 719         }
 720
 721         if (copy_from_user(&get_info, uptr, sizeof(get_info)))
 722                 return -EFAULT;
 723
 724         cid = vmci_ctx_get_id(vmci_host_dev->context);
 725         get_info.result = vmci_ctx_get_chkpt_state(cid, get_info.cpt_type,
 726                                                 &get_info.buf_size, &cpt_buf);
 727         if (get_info.result == VMCI_SUCCESS && get_info.buf_size) {
 728                 void __user *ubuf = (void __user *)(uintptr_t)get_info.cpt_buf;
 729                 retval = copy_to_user(ubuf, cpt_buf, get_info.buf_size);
 730                 kfree(cpt_buf);
 731
 732                 if (retval)
 733                         return -EFAULT;
 734         }
 735
 736         return copy_to_user(uptr, &get_info, sizeof(get_info)) ? -EFAULT : 0;
 737 }
 738
 739 static int vmci_host_do_ctx_set_cpt_state(struct vmci_host_dev *vmci_host_dev,
 740                                           const char *ioctl_name,
 741                                           void __user *uptr)
 742 {
 743         struct vmci_ctx_chkpt_buf_info set_info;
 744         u32 cid;
 745         void *cpt_buf;
 746         int retval;
 747
 748         if (vmci_host_dev->ct_type != VMCIOBJ_CONTEXT) {
 749                 vmci_ioctl_err("only valid for contexts\n");
 750                 return -EINVAL;
 751         }
 752
 753         if (copy_from_user(&set_info, uptr, sizeof(set_info)))
 754                 return -EFAULT;
 755
 756         cpt_buf = memdup_user((void __user *)(uintptr_t)set_info.cpt_buf,
 757                                 set_info.buf_size);
 758         if (IS_ERR(cpt_buf))
 759                 return PTR_ERR(cpt_buf);
 760
 761         cid = vmci_ctx_get_id(vmci_host_dev->context);
 762         set_info.result = vmci_ctx_set_chkpt_state(cid, set_info.cpt_type,
 763                                                    set_info.buf_size, cpt_buf);
 764
 765         retval = copy_to_user(uptr, &set_info, sizeof(set_info)) ? -EFAULT : 0;
 766
 767         kfree(cpt_buf);
 768         return retval;
 769 }
 770
 771 static int vmci_host_do_get_context_id(struct vmci_host_dev *vmci_host_dev,
 772                                        const char *ioctl_name,
 773                                        void __user *uptr)
 774 {
 775         u32 __user *u32ptr = uptr;
 776
 777         return put_user(VMCI_HOST_CONTEXT_ID, u32ptr) ? -EFAULT : 0;
 778 }
 779
 780 static int vmci_host_do_set_notify(struct vmci_host_dev *vmci_host_dev,
 781                                    const char *ioctl_name,
 782                                    void __user *uptr)
 783 {
 784         struct vmci_set_notify_info notify_info;
 785
 786         if (vmci_host_dev->ct_type != VMCIOBJ_CONTEXT) {
 787                 vmci_ioctl_err("only valid for contexts\n");
 788                 return -EINVAL;
 789         }
 790
 791         if (copy_from_user(&notify_info, uptr, sizeof(notify_info)))
 792                 return -EFAULT;
 793
 794         if (notify_info.notify_uva) {
 795                 notify_info.result =
 796                         vmci_host_setup_notify(vmci_host_dev->context,
 797                                                notify_info.notify_uva);
 798         } else {
 799                 vmci_ctx_unset_notify(vmci_host_dev->context);
 800                 notify_info.result = VMCI_SUCCESS;
 801         }
 802
 803         return copy_to_user(uptr, &notify_info, sizeof(notify_info)) ?
 804                 -EFAULT : 0;
 805 }
 806
 807 static int vmci_host_do_notify_resource(struct vmci_host_dev *vmci_host_dev,
 808                                         const char *ioctl_name,
 809                                         void __user *uptr)
 810 {
 811         struct vmci_dbell_notify_resource_info info;
 812         u32 cid;
 813
 814         if (vmci_host_dev->user_version < VMCI_VERSION_NOTIFY) {
 815                 vmci_ioctl_err("invalid for current VMX versions\n");
 816                 return -EINVAL;
 817         }
 818
 819         if (vmci_host_dev->ct_type != VMCIOBJ_CONTEXT) {
 820                 vmci_ioctl_err("only valid for contexts\n");
 821                 return -EINVAL;
 822         }
 823
 824         if (copy_from_user(&info, uptr, sizeof(info)))
 825                 return -EFAULT;
 826
 827         cid = vmci_ctx_get_id(vmci_host_dev->context);
 828
 829         switch (info.action) {
 830         case VMCI_NOTIFY_RESOURCE_ACTION_NOTIFY:
 831                 if (info.resource == VMCI_NOTIFY_RESOURCE_DOOR_BELL) {
 832                         u32 flags = VMCI_NO_PRIVILEGE_FLAGS;
 833                         info.result = vmci_ctx_notify_dbell(cid, info.handle,
 834                                                             flags);
 835                 } else {
 836                         info.result = VMCI_ERROR_UNAVAILABLE;
 837                 }
 838                 break;
 839
 840         case VMCI_NOTIFY_RESOURCE_ACTION_CREATE:
 841                 info.result = vmci_ctx_dbell_create(cid, info.handle);
 842                 break;
 843
 844         case VMCI_NOTIFY_RESOURCE_ACTION_DESTROY:
 845                 info.result = vmci_ctx_dbell_destroy(cid, info.handle);
 846                 break;
 847
 848         default:
 849                 vmci_ioctl_err("got unknown action (action=%d)\n",
 850                                info.action);
 851                 info.result = VMCI_ERROR_INVALID_ARGS;
 852         }
 853
 854         return copy_to_user(uptr, &info, sizeof(info)) ? -EFAULT : 0;
 855 }
 856
 857 static int vmci_host_do_recv_notifications(struct vmci_host_dev *vmci_host_dev,
 858                                            const char *ioctl_name,
 859                                            void __user *uptr)
 860 {
 861         struct vmci_ctx_notify_recv_info info;
 862         struct vmci_handle_arr *db_handle_array;
 863         struct vmci_handle_arr *qp_handle_array;
 864         void __user *ubuf;
 865         u32 cid;
 866         int retval = 0;
 867
 868         if (vmci_host_dev->ct_type != VMCIOBJ_CONTEXT) {
 869                 vmci_ioctl_err("only valid for contexts\n");
 870                 return -EINVAL;
 871         }
 872
 873         if (vmci_host_dev->user_version < VMCI_VERSION_NOTIFY) {
 874                 vmci_ioctl_err("not supported for the current vmx version\n");
 875                 return -EINVAL;
 876         }
 877
 878         if (copy_from_user(&info, uptr, sizeof(info)))
 879                 return -EFAULT;
 880
 881         if ((info.db_handle_buf_size && !info.db_handle_buf_uva) ||
 882             (info.qp_handle_buf_size && !info.qp_handle_buf_uva)) {
 883                 return -EINVAL;
 884         }
 885
 886         cid = vmci_ctx_get_id(vmci_host_dev->context);
 887
 888         info.result = vmci_ctx_rcv_notifications_get(cid,
 889                                 &db_handle_array, &qp_handle_array);
 890         if (info.result != VMCI_SUCCESS)
 891                 return copy_to_user(uptr, &info, sizeof(info)) ? -EFAULT : 0;
 892
 893         ubuf = (void __user *)(uintptr_t)info.db_handle_buf_uva;
 894         info.result = drv_cp_harray_to_user(ubuf, &info.db_handle_buf_size,
 895                                             db_handle_array, &retval);
 896         if (info.result == VMCI_SUCCESS && !retval) {
 897                 ubuf = (void __user *)(uintptr_t)info.qp_handle_buf_uva;
 898                 info.result = drv_cp_harray_to_user(ubuf,
 899                                                     &info.qp_handle_buf_size,
 900                                                     qp_handle_array, &retval);
 901         }
 902
 903         if (!retval && copy_to_user(uptr, &info, sizeof(info)))
 904                 retval = -EFAULT;
 905
 906         vmci_ctx_rcv_notifications_release(cid,
 907                                 db_handle_array, qp_handle_array,
 908                                 info.result == VMCI_SUCCESS && !retval);
 909
 910         return retval;
 911 }
 912
 913 static long vmci_host_unlocked_ioctl(struct file *filp,
 914                                      unsigned int iocmd, unsigned long ioarg)
 915 {
 916 #define VMCI_DO_IOCTL(ioctl_name, ioctl_fn) do {                        \
 917                 char *name = __stringify(IOCTL_VMCI_ ## ioctl_name);    \
 918                 return vmci_host_do_ ## ioctl_fn(                       \
 919                         vmci_host_dev, name, uptr);                     \
 920         } while (0)
 921
 922         struct vmci_host_dev *vmci_host_dev = filp->private_data;
 923         void __user *uptr = (void __user *)ioarg;
 924
 925         switch (iocmd) {
 926         case IOCTL_VMCI_INIT_CONTEXT:
 927                 VMCI_DO_IOCTL(INIT_CONTEXT, init_context);
 928         case IOCTL_VMCI_DATAGRAM_SEND:
 929                 VMCI_DO_IOCTL(DATAGRAM_SEND, send_datagram);
 930         case IOCTL_VMCI_DATAGRAM_RECEIVE:
 931                 VMCI_DO_IOCTL(DATAGRAM_RECEIVE, receive_datagram);
 932         case IOCTL_VMCI_QUEUEPAIR_ALLOC:
 933                 VMCI_DO_IOCTL(QUEUEPAIR_ALLOC, alloc_queuepair);
 934         case IOCTL_VMCI_QUEUEPAIR_SETVA:
 935                 VMCI_DO_IOCTL(QUEUEPAIR_SETVA, queuepair_setva);
 936         case IOCTL_VMCI_QUEUEPAIR_SETPAGEFILE:
 937                 VMCI_DO_IOCTL(QUEUEPAIR_SETPAGEFILE, queuepair_setpf);
 938         case IOCTL_VMCI_QUEUEPAIR_DETACH:
 939                 VMCI_DO_IOCTL(QUEUEPAIR_DETACH, qp_detach);
 940         case IOCTL_VMCI_CTX_ADD_NOTIFICATION:
 941                 VMCI_DO_IOCTL(CTX_ADD_NOTIFICATION, ctx_add_notify);
 942         case IOCTL_VMCI_CTX_REMOVE_NOTIFICATION:
 943                 VMCI_DO_IOCTL(CTX_REMOVE_NOTIFICATION, ctx_remove_notify);
 944         case IOCTL_VMCI_CTX_GET_CPT_STATE:
 945                 VMCI_DO_IOCTL(CTX_GET_CPT_STATE, ctx_get_cpt_state);
 946         case IOCTL_VMCI_CTX_SET_CPT_STATE:
 947                 VMCI_DO_IOCTL(CTX_SET_CPT_STATE, ctx_set_cpt_state);
 948         case IOCTL_VMCI_GET_CONTEXT_ID:
 949                 VMCI_DO_IOCTL(GET_CONTEXT_ID, get_context_id);
 950         case IOCTL_VMCI_SET_NOTIFY:
 951                 VMCI_DO_IOCTL(SET_NOTIFY, set_notify);
 952         case IOCTL_VMCI_NOTIFY_RESOURCE:
 953                 VMCI_DO_IOCTL(NOTIFY_RESOURCE, notify_resource);
 954         case IOCTL_VMCI_NOTIFICATIONS_RECEIVE:
 955                 VMCI_DO_IOCTL(NOTIFICATIONS_RECEIVE, recv_notifications);
 956
 957         case IOCTL_VMCI_VERSION:
 958         case IOCTL_VMCI_VERSION2:
 959                 return vmci_host_get_version(vmci_host_dev, iocmd, uptr);
 960
 961         default:
 962                 pr_devel("%s: Unknown ioctl (iocmd=%d)\n", __func__, iocmd);
 963                 return -EINVAL;
 964         }
 965
 966 #undef VMCI_DO_IOCTL
 967 }
 968
 969 static const struct file_operations vmuser_fops = {
 970         .owner          = THIS_MODULE,
 971         .open           = vmci_host_open,
 972         .release        = vmci_host_close,
 973         .poll           = vmci_host_poll,
 974         .unlocked_ioctl = vmci_host_unlocked_ioctl,
 975         .compat_ioctl   = compat_ptr_ioctl,
 976 };
 977
 978 static struct miscdevice vmci_host_miscdev = {
 979          .name = "vmci",
 980          .minor = MISC_DYNAMIC_MINOR,
 981          .fops = &vmuser_fops,
 982 };
 983
 984 int __init vmci_host_init(void)
 985 {
 986         int error;
 987
 988         host_context = vmci_ctx_create(VMCI_HOST_CONTEXT_ID,
 989                                         VMCI_DEFAULT_PROC_PRIVILEGE_FLAGS,
 990                                         -1, VMCI_VERSION, NULL);
 991         if (IS_ERR(host_context)) {
 992                 error = PTR_ERR(host_context);
 993                 pr_warn("Failed to initialize VMCIContext (error%d)\n",
 994                         error);
 995                 return error;
 996         }
 997
 998         error = misc_register(&vmci_host_miscdev);
 999         if (error) {
1000                 pr_warn("Module registration error (name=%s, major=%d, minor=%d, err=%d)\n",
1001                         vmci_host_miscdev.name,
1002                         MISC_MAJOR, vmci_host_miscdev.minor,
1003                         error);
1004                 pr_warn("Unable to initialize host personality\n");
1005                 vmci_ctx_destroy(host_context);
1006                 return error;
1007         }
1008
1009         pr_info("VMCI host device registered (name=%s, major=%d, minor=%d)\n",
1010                 vmci_host_miscdev.name, MISC_MAJOR, vmci_host_miscdev.minor);
1011
1012         vmci_host_device_initialized = true;
1013         return 0;
1014 }
1015
1016 void __exit vmci_host_exit(void)
1017 {
1018         vmci_host_device_initialized = false;
1019
1020         misc_deregister(&vmci_host_miscdev);
1021         vmci_ctx_destroy(host_context);
1022         vmci_qp_broker_exit();
1023
1024         pr_debug("VMCI host driver module unloaded\n");
1025 }