sys/dev/xen/gntdev/gntdev.c

   1 /*-
   2  * Copyright (c) 2016 Akshay Jaggi <jaggi@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * gntdev.c
  27  *
  28  * Interface to /dev/xen/gntdev.
  29  *
  30  */
  31
  32 #include <sys/cdefs.h>
  33 __FBSDID("$FreeBSD$");
  34
  35 #include <sys/param.h>
  36 #include <sys/systm.h>
  37 #include <sys/uio.h>
  38 #include <sys/bus.h>
  39 #include <sys/malloc.h>
  40 #include <sys/kernel.h>
  41 #include <sys/lock.h>
  42 #include <sys/mutex.h>
  43 #include <sys/rwlock.h>
  44 #include <sys/selinfo.h>
  45 #include <sys/poll.h>
  46 #include <sys/conf.h>
  47 #include <sys/fcntl.h>
  48 #include <sys/ioccom.h>
  49 #include <sys/rman.h>
  50 #include <sys/tree.h>
  51 #include <sys/module.h>
  52 #include <sys/proc.h>
  53 #include <sys/bitset.h>
  54 #include <sys/queue.h>
  55 #include <sys/mman.h>
  56 #include <sys/syslog.h>
  57 #include <sys/taskqueue.h>
  58
  59 #include <vm/vm.h>
  60 #include <vm/vm_param.h>
  61 #include <vm/vm_extern.h>
  62 #include <vm/vm_kern.h>
  63 #include <vm/vm_page.h>
  64 #include <vm/vm_map.h>
  65 #include <vm/vm_object.h>
  66 #include <vm/vm_pager.h>
  67
  68 #include <machine/md_var.h>
  69
  70 #include <xen/xen-os.h>
  71 #include <xen/hypervisor.h>
  72 #include <xen/error.h>
  73 #include <xen/xen_intr.h>
  74 #include <xen/gnttab.h>
  75 #include <xen/gntdev.h>
  76
  77 MALLOC_DEFINE(M_GNTDEV, "gntdev", "Xen grant-table user-space device");
  78
  79 #define MAX_OFFSET_COUNT ((0xffffffffffffffffull >> PAGE_SHIFT) + 1)
  80
  81 static d_open_t gntdev_open;
  82 static d_ioctl_t gntdev_ioctl;
  83 static d_mmap_single_t gntdev_mmap_single;
  84
  85 static struct cdevsw gntdev_devsw = {
  86         .d_version = D_VERSION,
  87         .d_open = gntdev_open,
  88         .d_ioctl = gntdev_ioctl,
  89         .d_mmap_single = gntdev_mmap_single,
  90         .d_name = "gntdev",
  91 };
  92
  93 static device_t gntdev_dev = NULL;
  94
  95 struct gntdev_gref;
  96 struct gntdev_gmap;
  97 STAILQ_HEAD(gref_list_head, gntdev_gref);
  98 STAILQ_HEAD(gmap_list_head, gntdev_gmap);
  99 RB_HEAD(gref_tree_head, gntdev_gref);
 100 RB_HEAD(gmap_tree_head, gntdev_gmap);
 101
 102 struct file_offset_struct {
 103         RB_ENTRY(file_offset_struct)    next;
 104         uint64_t                        file_offset;
 105         uint64_t                        count;
 106 };
 107
 108 static int
 109 offset_cmp(struct file_offset_struct *f1, struct file_offset_struct *f2)
 110 {
 111         return (f1->file_offset - f2->file_offset);
 112 }
 113
 114 RB_HEAD(file_offset_head, file_offset_struct);
 115 RB_GENERATE_STATIC(file_offset_head, file_offset_struct, next, offset_cmp);
 116
 117 struct per_user_data {
 118         struct mtx              user_data_lock;
 119         struct gref_tree_head   gref_tree;
 120         struct gmap_tree_head   gmap_tree;
 121         struct file_offset_head file_offset;
 122 };
 123
 124 /*
 125  * Get offset into the file which will be used while mmapping the
 126  * appropriate pages by the userspace program.
 127  */
 128 static int
 129 get_file_offset(struct per_user_data *priv_user, uint32_t count,
 130     uint64_t *file_offset)
 131 {
 132         struct file_offset_struct *offset, *offset_tmp;
 133
 134         if (count == 0)
 135                 return (EINVAL);
 136         mtx_lock(&priv_user->user_data_lock);
 137         RB_FOREACH_SAFE(offset, file_offset_head, &priv_user->file_offset,
 138             offset_tmp) {
 139                 if (offset->count >= count) {
 140                         offset->count -= count;
 141                         *file_offset = offset->file_offset + offset->count *
 142                             PAGE_SIZE;
 143                         if (offset->count == 0) {
 144                                 RB_REMOVE(file_offset_head,
 145                                     &priv_user->file_offset, offset);
 146                                 free(offset, M_GNTDEV);
 147                         }
 148                         mtx_unlock(&priv_user->user_data_lock);
 149                         return (0);
 150                 }
 151         }
 152         mtx_unlock(&priv_user->user_data_lock);
 153
 154         return (ENOSPC);
 155 }
 156
 157 static void
 158 put_file_offset(struct per_user_data *priv_user, uint32_t count,
 159     uint64_t file_offset)
 160 {
 161         struct file_offset_struct *offset, *offset_nxt, *offset_prv;
 162
 163         offset = malloc(sizeof(*offset), M_GNTDEV, M_WAITOK | M_ZERO);
 164         offset->file_offset = file_offset;
 165         offset->count = count;
 166
 167         mtx_lock(&priv_user->user_data_lock);
 168         RB_INSERT(file_offset_head, &priv_user->file_offset, offset);
 169         offset_nxt = RB_NEXT(file_offset_head, &priv_user->file_offset, offset);
 170         offset_prv = RB_PREV(file_offset_head, &priv_user->file_offset, offset);
 171         if (offset_nxt != NULL &&
 172             offset_nxt->file_offset == offset->file_offset + offset->count *
 173             PAGE_SIZE) {
 174                 offset->count += offset_nxt->count;
 175                 RB_REMOVE(file_offset_head, &priv_user->file_offset,
 176                     offset_nxt);
 177                 free(offset_nxt, M_GNTDEV);
 178         }
 179         if (offset_prv != NULL &&
 180             offset->file_offset == offset_prv->file_offset + offset_prv->count *
 181             PAGE_SIZE) {
 182                 offset_prv->count += offset->count;
 183                 RB_REMOVE(file_offset_head, &priv_user->file_offset, offset);
 184                 free(offset, M_GNTDEV);
 185         }
 186         mtx_unlock(&priv_user->user_data_lock);
 187 }
 188
 189 static int      gntdev_gmap_pg_ctor(void *handle, vm_ooffset_t size,
 190     vm_prot_t prot, vm_ooffset_t foff, struct ucred *cred, u_short *color);
 191 static void     gntdev_gmap_pg_dtor(void *handle);
 192 static int      gntdev_gmap_pg_fault(vm_object_t object, vm_ooffset_t offset,
 193     int prot, vm_page_t *mres);
 194
 195 static struct cdev_pager_ops gntdev_gmap_pg_ops = {
 196         .cdev_pg_fault = gntdev_gmap_pg_fault,
 197         .cdev_pg_ctor = gntdev_gmap_pg_ctor,
 198         .cdev_pg_dtor = gntdev_gmap_pg_dtor,
 199 };
 200
 201 struct cleanup_data_struct {
 202         struct mtx to_kill_grefs_mtx;
 203         struct mtx to_kill_gmaps_mtx;
 204         struct gref_list_head to_kill_grefs;
 205         struct gmap_list_head to_kill_gmaps;
 206 };
 207
 208 static struct cleanup_data_struct cleanup_data = {
 209         .to_kill_grefs = STAILQ_HEAD_INITIALIZER(cleanup_data.to_kill_grefs),
 210         .to_kill_gmaps = STAILQ_HEAD_INITIALIZER(cleanup_data.to_kill_gmaps),
 211 };
 212 MTX_SYSINIT(to_kill_grefs_mtx, &cleanup_data.to_kill_grefs_mtx,
 213     "gntdev to_kill_grefs mutex", MTX_DEF);
 214 MTX_SYSINIT(to_kill_gmaps_mtx, &cleanup_data.to_kill_gmaps_mtx,
 215     "gntdev to_kill_gmaps mutex", MTX_DEF);
 216
 217 static void     cleanup_function(void *arg, __unused int pending);
 218 static struct task cleanup_task = TASK_INITIALIZER(0, cleanup_function,
 219     &cleanup_data);
 220
 221 struct notify_data {
 222         uint64_t                index;
 223         uint32_t                action;
 224         uint32_t                event_channel_port;
 225         xen_intr_handle_t       notify_evtchn_handle;
 226 };
 227
 228 static void     notify(struct notify_data *notify, vm_page_t page);
 229
 230 /*-------------------- Grant Allocation Methods  -----------------------------*/
 231
 232 struct gntdev_gref {
 233         union gref_next_union {
 234                 STAILQ_ENTRY(gntdev_gref)               list;
 235                 RB_ENTRY(gntdev_gref)                   tree;
 236         }                       gref_next;
 237         uint64_t                file_index;
 238         grant_ref_t             gref_id;
 239         vm_page_t               page;
 240         struct notify_data      *notify;
 241 };
 242
 243 static int
 244 gref_cmp(struct gntdev_gref *g1, struct gntdev_gref *g2)
 245 {
 246         return (g1->file_index - g2->file_index);
 247 }
 248
 249 RB_GENERATE_STATIC(gref_tree_head, gntdev_gref, gref_next.tree, gref_cmp);
 250
 251 /*
 252  * Traverse over the device-list of to-be-deleted grants allocated, and
 253  * if all accesses, both local mmaps and foreign maps, to them have ended,
 254  * destroy them.
 255  */
 256 static void
 257 gref_list_dtor(struct cleanup_data_struct *cleanup_data)
 258 {
 259         struct gref_list_head tmp_grefs;
 260         struct gntdev_gref *gref, *gref_tmp, *gref_previous;
 261
 262         STAILQ_INIT(&tmp_grefs);
 263         mtx_lock(&cleanup_data->to_kill_grefs_mtx);
 264         STAILQ_SWAP(&cleanup_data->to_kill_grefs, &tmp_grefs, gntdev_gref);
 265         mtx_unlock(&cleanup_data->to_kill_grefs_mtx);
 266
 267         gref_previous = NULL;
 268         STAILQ_FOREACH_SAFE(gref, &tmp_grefs, gref_next.list, gref_tmp) {
 269                 if (gref->page && gref->page->object == NULL) {
 270                         if (gref->notify) {
 271                                 notify(gref->notify, gref->page);
 272                         }
 273                         if (gref->gref_id != GRANT_REF_INVALID) {
 274                                 if (gnttab_query_foreign_access(gref->gref_id))
 275                                         continue;
 276                                 if (gnttab_end_foreign_access_ref(gref->gref_id)
 277                                     == 0)
 278                                         continue;
 279                                 gnttab_free_grant_reference(gref->gref_id);
 280                         }
 281                         vm_page_unwire(gref->page, PQ_NONE);
 282                         vm_page_free(gref->page);
 283                         gref->page = NULL;
 284                 }
 285                 if (gref->page == NULL) {
 286                         if (gref_previous == NULL)
 287                                 STAILQ_REMOVE_HEAD(&tmp_grefs, gref_next.list);
 288                         else
 289                                 STAILQ_REMOVE_AFTER(&tmp_grefs, gref_previous,
 290                                     gref_next.list);
 291                         if (gref->notify)
 292                                 free(gref->notify, M_GNTDEV);
 293                         free(gref, M_GNTDEV);
 294                 }
 295                 else
 296                         gref_previous = gref;
 297         }
 298
 299         if (!STAILQ_EMPTY(&tmp_grefs)) {
 300                 mtx_lock(&cleanup_data->to_kill_grefs_mtx);
 301                 STAILQ_CONCAT(&cleanup_data->to_kill_grefs, &tmp_grefs);
 302                 mtx_unlock(&cleanup_data->to_kill_grefs_mtx);
 303         }
 304 }
 305
 306 /*
 307  * Find count number of contiguous allocated grants for a given userspace
 308  * program by file-offset (index).
 309  */
 310 static struct gntdev_gref*
 311 gntdev_find_grefs(struct per_user_data *priv_user,
 312         uint64_t index, uint32_t count)
 313 {
 314         struct gntdev_gref find_gref, *gref, *gref_start = NULL;
 315
 316         find_gref.file_index = index;
 317
 318         mtx_lock(&priv_user->user_data_lock);
 319         gref_start = RB_FIND(gref_tree_head, &priv_user->gref_tree, &find_gref);
 320         for (gref = gref_start; gref != NULL && count > 0; gref =
 321             RB_NEXT(gref_tree_head, &priv_user->gref_tree, gref)) {
 322                 if (index != gref->file_index)
 323                         break;
 324                 index += PAGE_SIZE;
 325                 count--;
 326         }
 327         mtx_unlock(&priv_user->user_data_lock);
 328
 329         if (count)
 330                 return (NULL);
 331         return (gref_start);
 332 }
 333
 334 /*
 335  * IOCTL_GNTDEV_ALLOC_GREF
 336  * Allocate required number of wired pages for the request, grant foreign
 337  * access to the physical frames for these pages, and add details about
 338  * this allocation to the per user private data, so that these pages can
 339  * be mmapped by the userspace program.
 340  */
 341 static int
 342 gntdev_alloc_gref(struct ioctl_gntdev_alloc_gref *arg)
 343 {
 344         uint32_t i;
 345         int error, readonly;
 346         uint64_t file_offset;
 347         struct gntdev_gref *grefs;
 348         struct per_user_data *priv_user;
 349
 350         readonly = !(arg->flags & GNTDEV_ALLOC_FLAG_WRITABLE);
 351
 352         error = devfs_get_cdevpriv((void**) &priv_user);
 353         if (error != 0)
 354                 return (EINVAL);
 355
 356         /* Cleanup grefs and free pages. */
 357         taskqueue_enqueue(taskqueue_thread, &cleanup_task);
 358
 359         /* Get file offset for this request. */
 360         error = get_file_offset(priv_user, arg->count, &file_offset);
 361         if (error != 0)
 362                 return (error);
 363
 364         /* Allocate grefs. */
 365         grefs = malloc(sizeof(*grefs) * arg->count, M_GNTDEV, M_WAITOK);
 366
 367         for (i = 0; i < arg->count; i++) {
 368                 grefs[i].file_index = file_offset + i * PAGE_SIZE;
 369                 grefs[i].gref_id = GRANT_REF_INVALID;
 370                 grefs[i].notify = NULL;
 371                 grefs[i].page = vm_page_alloc(NULL, 0, VM_ALLOC_NORMAL
 372                         | VM_ALLOC_NOOBJ | VM_ALLOC_WIRED | VM_ALLOC_ZERO);
 373                 if (grefs[i].page == NULL) {
 374                         log(LOG_ERR, "Page allocation failed.");
 375                         error = ENOMEM;
 376                         break;
 377                 }
 378                 if ((grefs[i].page->flags & PG_ZERO) == 0) {
 379                         /*
 380                          * Zero the allocated page, as we don't want to
 381                          * leak our memory to other domains.
 382                          */
 383                         pmap_zero_page(grefs[i].page);
 384                 }
 385                 grefs[i].page->valid = VM_PAGE_BITS_ALL;
 386
 387                 error = gnttab_grant_foreign_access(arg->domid,
 388                         (VM_PAGE_TO_PHYS(grefs[i].page) >> PAGE_SHIFT),
 389                         readonly, &grefs[i].gref_id);
 390                 if (error != 0) {
 391                         log(LOG_ERR, "Grant Table Hypercall failed.");
 392                         break;
 393                 }
 394         }
 395
 396         if (error != 0) {
 397                 /*
 398                  * If target domain maps the gref (by guessing the gref-id),
 399                  * then we can't clean it up yet and we have to leave the
 400                  * page in place so as to not leak our memory to that domain.
 401                  * Add it to a global list to be cleaned up later.
 402                  */
 403                 mtx_lock(&cleanup_data.to_kill_grefs_mtx);
 404                 for (i = 0; i < arg->count; i++)
 405                         STAILQ_INSERT_TAIL(&cleanup_data.to_kill_grefs,
 406                             &grefs[i], gref_next.list);
 407                 mtx_unlock(&cleanup_data.to_kill_grefs_mtx);
 408
 409                 taskqueue_enqueue(taskqueue_thread, &cleanup_task);
 410
 411                 return (error);
 412         }
 413
 414         /* Copy the output values. */
 415         arg->index = file_offset;
 416         for (i = 0; i < arg->count; i++)
 417                 arg->gref_ids[i] = grefs[i].gref_id;
 418
 419         /* Modify the per user private data. */
 420         mtx_lock(&priv_user->user_data_lock);
 421         for (i = 0; i < arg->count; i++)
 422                 RB_INSERT(gref_tree_head, &priv_user->gref_tree, &grefs[i]);
 423         mtx_unlock(&priv_user->user_data_lock);
 424
 425         return (error);
 426 }
 427
 428 /*
 429  * IOCTL_GNTDEV_DEALLOC_GREF
 430  * Remove grant allocation information from the per user private data, so
 431  * that it can't be mmapped anymore by the userspace program, and add it
 432  * to the to-be-deleted grants global device-list.
 433  */
 434 static int
 435 gntdev_dealloc_gref(struct ioctl_gntdev_dealloc_gref *arg)
 436 {
 437         int error;
 438         uint32_t count;
 439         struct gntdev_gref *gref, *gref_tmp;
 440         struct per_user_data *priv_user;
 441
 442         error = devfs_get_cdevpriv((void**) &priv_user);
 443         if (error != 0)
 444                 return (EINVAL);
 445
 446         gref = gntdev_find_grefs(priv_user, arg->index, arg->count);
 447         if (gref == NULL) {
 448                 log(LOG_ERR, "Can't find requested grant-refs.");
 449                 return (EINVAL);
 450         }
 451
 452         /* Remove the grefs from user private data. */
 453         count = arg->count;
 454         mtx_lock(&priv_user->user_data_lock);
 455         mtx_lock(&cleanup_data.to_kill_grefs_mtx);
 456         for (; gref != NULL && count > 0; gref = gref_tmp) {
 457                 gref_tmp = RB_NEXT(gref_tree_head, &priv_user->gref_tree, gref);
 458                 RB_REMOVE(gref_tree_head, &priv_user->gref_tree, gref);
 459                 STAILQ_INSERT_TAIL(&cleanup_data.to_kill_grefs, gref,
 460                     gref_next.list);
 461                 count--;
 462         }
 463         mtx_unlock(&cleanup_data.to_kill_grefs_mtx);
 464         mtx_unlock(&priv_user->user_data_lock);
 465
 466         taskqueue_enqueue(taskqueue_thread, &cleanup_task);
 467         put_file_offset(priv_user, arg->count, arg->index);
 468
 469         return (0);
 470 }
 471
 472 /*-------------------- Grant Mapping Methods  --------------------------------*/
 473
 474 struct gntdev_gmap_map {
 475         vm_object_t     mem;
 476         struct resource *pseudo_phys_res;
 477         int             pseudo_phys_res_id;
 478         vm_paddr_t      phys_base_addr;
 479 };
 480
 481 struct gntdev_gmap {
 482         union gmap_next_union {
 483                 STAILQ_ENTRY(gntdev_gmap)               list;
 484                 RB_ENTRY(gntdev_gmap)                   tree;
 485         }                               gmap_next;
 486         uint64_t                        file_index;
 487         uint32_t                        count;
 488         struct gnttab_map_grant_ref     *grant_map_ops;
 489         struct gntdev_gmap_map          *map;
 490         struct notify_data              *notify;
 491 };
 492
 493 static int
 494 gmap_cmp(struct gntdev_gmap *g1, struct gntdev_gmap *g2)
 495 {
 496         return (g1->file_index - g2->file_index);
 497 }
 498
 499 RB_GENERATE_STATIC(gmap_tree_head, gntdev_gmap, gmap_next.tree, gmap_cmp);
 500
 501 /*
 502  * Traverse over the device-list of to-be-deleted grant mappings, and if
 503  * the region is no longer mmapped by anyone, free the memory used to
 504  * store information about the mapping.
 505  */
 506 static void
 507 gmap_list_dtor(struct cleanup_data_struct *cleanup_data)
 508 {
 509         struct gmap_list_head tmp_gmaps;
 510         struct gntdev_gmap *gmap, *gmap_tmp, *gmap_previous;
 511
 512         STAILQ_INIT(&tmp_gmaps);
 513         mtx_lock(&cleanup_data->to_kill_gmaps_mtx);
 514         STAILQ_SWAP(&cleanup_data->to_kill_gmaps, &tmp_gmaps, gntdev_gmap);
 515         mtx_unlock(&cleanup_data->to_kill_gmaps_mtx);
 516
 517         gmap_previous = NULL;
 518         STAILQ_FOREACH_SAFE(gmap, &tmp_gmaps, gmap_next.list, gmap_tmp) {
 519                 if (gmap->map == NULL) {
 520                         if (gmap_previous == NULL)
 521                                 STAILQ_REMOVE_HEAD(&tmp_gmaps, gmap_next.list);
 522                         else
 523                                 STAILQ_REMOVE_AFTER(&tmp_gmaps, gmap_previous,
 524                                     gmap_next.list);
 525
 526                         if (gmap->notify)
 527                                 free(gmap->notify, M_GNTDEV);
 528                         free(gmap->grant_map_ops, M_GNTDEV);
 529                         free(gmap, M_GNTDEV);
 530                 }
 531                 else
 532                         gmap_previous = gmap;
 533         }
 534
 535         if (!STAILQ_EMPTY(&tmp_gmaps)) {
 536                 mtx_lock(&cleanup_data->to_kill_gmaps_mtx);
 537                 STAILQ_CONCAT(&cleanup_data->to_kill_gmaps, &tmp_gmaps);
 538                 mtx_unlock(&cleanup_data->to_kill_gmaps_mtx);
 539         }
 540 }
 541
 542 /*
 543  * Find mapped grants for a given userspace program, by file-offset (index)
 544  * and count, as supplied during the map-ioctl.
 545  */
 546 static struct gntdev_gmap*
 547 gntdev_find_gmap(struct per_user_data *priv_user,
 548         uint64_t index, uint32_t count)
 549 {
 550         struct gntdev_gmap find_gmap, *gmap;
 551
 552         find_gmap.file_index = index;
 553
 554         mtx_lock(&priv_user->user_data_lock);
 555         gmap = RB_FIND(gmap_tree_head, &priv_user->gmap_tree, &find_gmap);
 556         mtx_unlock(&priv_user->user_data_lock);
 557
 558         if (gmap != NULL && gmap->count == count)
 559                 return (gmap);
 560         return (NULL);
 561 }
 562
 563 /*
 564  * Remove the pages from the mgtdevice pager, call the unmap hypercall,
 565  * free the xenmem resource. This function is called during the
 566  * destruction of the mgtdevice pager, which happens when all mmaps to
 567  * it have been removed, and the unmap-ioctl has been performed.
 568  */
 569 static int
 570 notify_unmap_cleanup(struct gntdev_gmap *gmap)
 571 {
 572         uint32_t i;
 573         int error, count;
 574         vm_page_t m;
 575         struct gnttab_unmap_grant_ref *unmap_ops;
 576
 577         unmap_ops = malloc(sizeof(struct gnttab_unmap_grant_ref) * gmap->count,
 578                         M_GNTDEV, M_WAITOK);
 579
 580         /* Enumerate freeable maps. */
 581         count = 0;
 582         for (i = 0; i < gmap->count; i++) {
 583                 if (gmap->grant_map_ops[i].handle != -1) {
 584                         unmap_ops[count].handle = gmap->grant_map_ops[i].handle;
 585                         unmap_ops[count].host_addr =
 586                                 gmap->grant_map_ops[i].host_addr;
 587                         unmap_ops[count].dev_bus_addr = 0;
 588                         count++;
 589                 }
 590         }
 591
 592         /* Perform notification. */
 593         if (count > 0 && gmap->notify) {
 594                 vm_page_t page;
 595                 uint64_t page_offset;
 596
 597                 page_offset = gmap->notify->index - gmap->file_index;
 598                 page = PHYS_TO_VM_PAGE(gmap->map->phys_base_addr + page_offset);
 599                 notify(gmap->notify, page);
 600         }
 601
 602         /* Free the pages. */
 603         VM_OBJECT_WLOCK(gmap->map->mem);
 604 retry:
 605         for (i = 0; i < gmap->count; i++) {
 606                 m = vm_page_lookup(gmap->map->mem, i);
 607                 if (m == NULL)
 608                         continue;
 609                 if (vm_page_sleep_if_busy(m, "pcmdum"))
 610                         goto retry;
 611                 cdev_pager_free_page(gmap->map->mem, m);
 612         }
 613         VM_OBJECT_WUNLOCK(gmap->map->mem);
 614
 615         /* Perform unmap hypercall. */
 616         error = HYPERVISOR_grant_table_op(GNTTABOP_unmap_grant_ref,
 617             unmap_ops, count);
 618
 619         for (i = 0; i < gmap->count; i++) {
 620                 gmap->grant_map_ops[i].handle = -1;
 621                 gmap->grant_map_ops[i].host_addr = 0;
 622         }
 623
 624         if (gmap->map) {
 625                 error = xenmem_free(gntdev_dev, gmap->map->pseudo_phys_res_id,
 626                     gmap->map->pseudo_phys_res);
 627                 KASSERT(error == 0,
 628                     ("Unable to release memory resource: %d", error));
 629
 630                 free(gmap->map, M_GNTDEV);
 631                 gmap->map = NULL;
 632         }
 633
 634         free(unmap_ops, M_GNTDEV);
 635
 636         return (error);
 637 }
 638
 639 /*
 640  * IOCTL_GNTDEV_MAP_GRANT_REF
 641  * Populate structures for mapping the grant reference in the per user
 642  * private data. Actual resource allocation and map hypercall is performed
 643  * during the mmap.
 644  */
 645 static int
 646 gntdev_map_grant_ref(struct ioctl_gntdev_map_grant_ref *arg)
 647 {
 648         uint32_t i;
 649         int error;
 650         struct gntdev_gmap *gmap;
 651         struct per_user_data *priv_user;
 652
 653         error = devfs_get_cdevpriv((void**) &priv_user);
 654         if (error != 0)
 655                 return (EINVAL);
 656
 657         gmap = malloc(sizeof(*gmap), M_GNTDEV, M_WAITOK | M_ZERO);
 658         gmap->count = arg->count;
 659         gmap->grant_map_ops =
 660             malloc(sizeof(struct gnttab_map_grant_ref) * arg->count,
 661                 M_GNTDEV, M_WAITOK | M_ZERO);
 662
 663         error = get_file_offset(priv_user, arg->count, &gmap->file_index);
 664         if (error != 0)
 665                 return (error);
 666
 667         for (i = 0; i < arg->count; i++) {
 668                 gmap->grant_map_ops[i].dom = arg->refs[i].domid;
 669                 gmap->grant_map_ops[i].ref = arg->refs[i].ref;
 670                 gmap->grant_map_ops[i].handle = -1;
 671                 gmap->grant_map_ops[i].flags = GNTMAP_host_map;
 672         }
 673
 674         mtx_lock(&priv_user->user_data_lock);
 675         RB_INSERT(gmap_tree_head, &priv_user->gmap_tree, gmap);
 676         mtx_unlock(&priv_user->user_data_lock);
 677
 678         arg->index = gmap->file_index;
 679
 680         return (error);
 681 }
 682
 683 /*
 684  * IOCTL_GNTDEV_UNMAP_GRANT_REF
 685  * Remove the map information from the per user private data and add it
 686  * to the global device-list of mappings to be deleted. A reference to
 687  * the mgtdevice pager is also decreased, the reason for which is
 688  * explained in mmap_gmap().
 689  */
 690 static int
 691 gntdev_unmap_grant_ref(struct ioctl_gntdev_unmap_grant_ref *arg)
 692 {
 693         int error;
 694         struct gntdev_gmap *gmap;
 695         struct per_user_data *priv_user;
 696
 697         error = devfs_get_cdevpriv((void**) &priv_user);
 698         if (error != 0)
 699                 return (EINVAL);
 700
 701         gmap = gntdev_find_gmap(priv_user, arg->index, arg->count);
 702         if (gmap == NULL) {
 703                 log(LOG_ERR, "Can't find requested grant-map.");
 704                 return (EINVAL);
 705         }
 706
 707         mtx_lock(&priv_user->user_data_lock);
 708         mtx_lock(&cleanup_data.to_kill_gmaps_mtx);
 709         RB_REMOVE(gmap_tree_head, &priv_user->gmap_tree, gmap);
 710         STAILQ_INSERT_TAIL(&cleanup_data.to_kill_gmaps, gmap, gmap_next.list);
 711         mtx_unlock(&cleanup_data.to_kill_gmaps_mtx);
 712         mtx_unlock(&priv_user->user_data_lock);
 713
 714         if (gmap->map)
 715                 vm_object_deallocate(gmap->map->mem);
 716
 717         taskqueue_enqueue(taskqueue_thread, &cleanup_task);
 718         put_file_offset(priv_user, arg->count, arg->index);
 719
 720         return (0);
 721 }
 722
 723 /*
 724  * IOCTL_GNTDEV_GET_OFFSET_FOR_VADDR
 725  * Get file-offset and count for a given mapping, from the virtual address
 726  * where the mapping is mmapped.
 727  * Please note, this only works for grants mapped by this domain, and not
 728  * grants allocated. Count doesn't make much sense in reference to grants
 729  * allocated. Also, because this function is present in the linux gntdev
 730  * device, but not in the linux gntalloc one, most userspace code only use
 731  * it for mapped grants.
 732  */
 733 static int
 734 gntdev_get_offset_for_vaddr(struct ioctl_gntdev_get_offset_for_vaddr *arg,
 735         struct thread *td)
 736 {
 737         int error;
 738         vm_map_t map;
 739         vm_map_entry_t entry;
 740         vm_object_t mem;
 741         vm_pindex_t pindex;
 742         vm_prot_t prot;
 743         boolean_t wired;
 744         struct gntdev_gmap *gmap;
 745         int rc;
 746
 747         map = &td->td_proc->p_vmspace->vm_map;
 748         error = vm_map_lookup(&map, arg->vaddr, VM_PROT_NONE, &entry,
 749                     &mem, &pindex, &prot, &wired);
 750         if (error != KERN_SUCCESS)
 751                 return (EINVAL);
 752
 753         if ((mem->type != OBJT_MGTDEVICE) ||
 754             (mem->un_pager.devp.ops != &gntdev_gmap_pg_ops)) {
 755                 rc = EINVAL;
 756                 goto out;
 757         }
 758
 759         gmap = mem->handle;
 760         if (gmap == NULL ||
 761             (entry->end - entry->start) != (gmap->count * PAGE_SIZE)) {
 762                 rc = EINVAL;
 763                 goto out;
 764         }
 765
 766         arg->count = gmap->count;
 767         arg->offset = gmap->file_index;
 768         rc = 0;
 769
 770 out:
 771         vm_map_lookup_done(map, entry);
 772         return (rc);
 773 }
 774
 775 /*-------------------- Grant Mapping Pager  ----------------------------------*/
 776
 777 static int
 778 gntdev_gmap_pg_ctor(void *handle, vm_ooffset_t size, vm_prot_t prot,
 779     vm_ooffset_t foff, struct ucred *cred, u_short *color)
 780 {
 781
 782         return (0);
 783 }
 784
 785 static void
 786 gntdev_gmap_pg_dtor(void *handle)
 787 {
 788
 789         notify_unmap_cleanup((struct gntdev_gmap *)handle);
 790 }
 791
 792 static int
 793 gntdev_gmap_pg_fault(vm_object_t object, vm_ooffset_t offset, int prot,
 794     vm_page_t *mres)
 795 {
 796         struct gntdev_gmap *gmap = object->handle;
 797         vm_pindex_t pidx, ridx;
 798         vm_page_t page, oldm;
 799         vm_ooffset_t relative_offset;
 800
 801         if (gmap->map == NULL)
 802                 return (VM_PAGER_FAIL);
 803
 804         relative_offset = offset - gmap->file_index;
 805
 806         pidx = UOFF_TO_IDX(offset);
 807         ridx = UOFF_TO_IDX(relative_offset);
 808         if (ridx >= gmap->count ||
 809             gmap->grant_map_ops[ridx].status != GNTST_okay)
 810                 return (VM_PAGER_FAIL);
 811
 812         page = PHYS_TO_VM_PAGE(gmap->map->phys_base_addr + relative_offset);
 813         if (page == NULL)
 814                 return (VM_PAGER_FAIL);
 815
 816         KASSERT((page->flags & PG_FICTITIOUS) != 0,
 817             ("not fictitious %p", page));
 818         KASSERT(page->wire_count == 1, ("wire_count not 1 %p", page));
 819         KASSERT(vm_page_busied(page) == 0, ("page %p is busy", page));
 820
 821         if (*mres != NULL) {
 822                 oldm = *mres;
 823                 vm_page_lock(oldm);
 824                 vm_page_free(oldm);
 825                 vm_page_unlock(oldm);
 826                 *mres = NULL;
 827         }
 828
 829         vm_page_insert(page, object, pidx);
 830         page->valid = VM_PAGE_BITS_ALL;
 831         vm_page_xbusy(page);
 832         *mres = page;
 833         return (VM_PAGER_OK);
 834 }
 835
 836 /*------------------ Grant Table Methods  ------------------------------------*/
 837
 838 static void
 839 notify(struct notify_data *notify, vm_page_t page)
 840 {
 841         if (notify->action & UNMAP_NOTIFY_CLEAR_BYTE) {
 842                 uint8_t *mem;
 843                 uint64_t offset;
 844
 845                 offset = notify->index & PAGE_MASK;
 846                 mem = (uint8_t *)pmap_quick_enter_page(page);
 847                 mem[offset] = 0;
 848                 pmap_quick_remove_page((vm_offset_t)mem);
 849         }
 850         if (notify->action & UNMAP_NOTIFY_SEND_EVENT) {
 851                 xen_intr_signal(notify->notify_evtchn_handle);
 852                 xen_intr_unbind(&notify->notify_evtchn_handle);
 853         }
 854         notify->action = 0;
 855 }
 856
 857 /*
 858  * Helper to copy new arguments from the notify ioctl into
 859  * the existing notify data.
 860  */
 861 static int
 862 copy_notify_helper(struct notify_data *destination,
 863     struct ioctl_gntdev_unmap_notify *source)
 864 {
 865         xen_intr_handle_t handlep = NULL;
 866
 867         /*
 868          * "Get" before "Put"ting previous reference, as we might be
 869          * holding the last reference to the event channel port.
 870          */
 871         if (source->action & UNMAP_NOTIFY_SEND_EVENT)
 872                 if (xen_intr_get_evtchn_from_port(source->event_channel_port,
 873                     &handlep) != 0)
 874                         return (EINVAL);
 875
 876         if (destination->action & UNMAP_NOTIFY_SEND_EVENT)
 877                 xen_intr_unbind(&destination->notify_evtchn_handle);
 878
 879         destination->action = source->action;
 880         destination->event_channel_port = source->event_channel_port;
 881         destination->index = source->index;
 882         destination->notify_evtchn_handle = handlep;
 883
 884         return (0);
 885 }
 886
 887 /*
 888  * IOCTL_GNTDEV_SET_UNMAP_NOTIFY
 889  * Set unmap notification inside the appropriate grant. It sends a
 890  * notification when the grant is completely munmapped by this domain
 891  * and ready for destruction.
 892  */
 893 static int
 894 gntdev_set_unmap_notify(struct ioctl_gntdev_unmap_notify *arg)
 895 {
 896         int error;
 897         uint64_t index;
 898         struct per_user_data *priv_user;
 899         struct gntdev_gref *gref = NULL;
 900         struct gntdev_gmap *gmap;
 901
 902         error = devfs_get_cdevpriv((void**) &priv_user);
 903         if (error != 0)
 904                 return (EINVAL);
 905
 906         if (arg->action & ~(UNMAP_NOTIFY_CLEAR_BYTE|UNMAP_NOTIFY_SEND_EVENT))
 907                 return (EINVAL);
 908
 909         index = arg->index & ~PAGE_MASK;
 910         gref = gntdev_find_grefs(priv_user, index, 1);
 911         if (gref) {
 912                 if (gref->notify == NULL)
 913                         gref->notify = malloc(sizeof(*arg), M_GNTDEV,
 914                             M_WAITOK | M_ZERO);
 915                 return (copy_notify_helper(gref->notify, arg));
 916         }
 917
 918         error = EINVAL;
 919         mtx_lock(&priv_user->user_data_lock);
 920         RB_FOREACH(gmap, gmap_tree_head, &priv_user->gmap_tree) {
 921                 if (arg->index >= gmap->file_index &&
 922                     arg->index < gmap->file_index + gmap->count * PAGE_SIZE) {
 923                         if (gmap->notify == NULL)
 924                                 gmap->notify = malloc(sizeof(*arg), M_GNTDEV,
 925                                     M_WAITOK | M_ZERO);
 926                         error = copy_notify_helper(gmap->notify, arg);
 927                         break;
 928                 }
 929         }
 930         mtx_unlock(&priv_user->user_data_lock);
 931
 932         return (error);
 933 }
 934
 935 /*------------------ Gntdev Char Device Methods  -----------------------------*/
 936
 937 static void
 938 cleanup_function(void *arg, __unused int pending)
 939 {
 940
 941         gref_list_dtor((struct cleanup_data_struct *) arg);
 942         gmap_list_dtor((struct cleanup_data_struct *) arg);
 943 }
 944
 945 static void
 946 per_user_data_dtor(void *arg)
 947 {
 948         struct gntdev_gref *gref, *gref_tmp;
 949         struct gntdev_gmap *gmap, *gmap_tmp;
 950         struct file_offset_struct *offset, *offset_tmp;
 951         struct per_user_data *priv_user;
 952
 953         priv_user = (struct per_user_data *) arg;
 954
 955         mtx_lock(&priv_user->user_data_lock);
 956
 957         mtx_lock(&cleanup_data.to_kill_grefs_mtx);
 958         RB_FOREACH_SAFE(gref, gref_tree_head, &priv_user->gref_tree, gref_tmp) {
 959                 RB_REMOVE(gref_tree_head, &priv_user->gref_tree, gref);
 960                 STAILQ_INSERT_TAIL(&cleanup_data.to_kill_grefs, gref,
 961                     gref_next.list);
 962         }
 963         mtx_unlock(&cleanup_data.to_kill_grefs_mtx);
 964
 965         mtx_lock(&cleanup_data.to_kill_gmaps_mtx);
 966         RB_FOREACH_SAFE(gmap, gmap_tree_head, &priv_user->gmap_tree, gmap_tmp) {
 967                 RB_REMOVE(gmap_tree_head, &priv_user->gmap_tree, gmap);
 968                 STAILQ_INSERT_TAIL(&cleanup_data.to_kill_gmaps, gmap,
 969                     gmap_next.list);
 970                 if (gmap->map)
 971                         vm_object_deallocate(gmap->map->mem);
 972         }
 973         mtx_unlock(&cleanup_data.to_kill_gmaps_mtx);
 974
 975         RB_FOREACH_SAFE(offset, file_offset_head, &priv_user->file_offset,
 976             offset_tmp) {
 977                 RB_REMOVE(file_offset_head, &priv_user->file_offset, offset);
 978                 free(offset, M_GNTDEV);
 979         }
 980
 981         mtx_unlock(&priv_user->user_data_lock);
 982
 983         taskqueue_enqueue(taskqueue_thread, &cleanup_task);
 984
 985         mtx_destroy(&priv_user->user_data_lock);
 986         free(priv_user, M_GNTDEV);
 987 }
 988
 989 static int
 990 gntdev_open(struct cdev *dev, int flag, int otyp, struct thread *td)
 991 {
 992         int error;
 993         struct per_user_data *priv_user;
 994         struct file_offset_struct *offset;
 995
 996         priv_user = malloc(sizeof(*priv_user), M_GNTDEV, M_WAITOK | M_ZERO);
 997         RB_INIT(&priv_user->gref_tree);
 998         RB_INIT(&priv_user->gmap_tree);
 999         RB_INIT(&priv_user->file_offset);
1000         offset = malloc(sizeof(*offset), M_GNTDEV, M_WAITOK | M_ZERO);
1001         offset->file_offset = 0;
1002         offset->count = MAX_OFFSET_COUNT;
1003         RB_INSERT(file_offset_head, &priv_user->file_offset, offset);
1004         mtx_init(&priv_user->user_data_lock,
1005             "per user data mutex", NULL, MTX_DEF);
1006
1007         error = devfs_set_cdevpriv(priv_user, per_user_data_dtor);
1008         if (error != 0)
1009                 per_user_data_dtor(priv_user);
1010
1011         return (error);
1012 }
1013
1014 static int
1015 gntdev_ioctl(struct cdev *dev, u_long cmd, caddr_t data,
1016         int fflag, struct thread *td)
1017 {
1018         int error;
1019
1020         switch (cmd) {
1021         case IOCTL_GNTDEV_SET_UNMAP_NOTIFY:
1022                 error = gntdev_set_unmap_notify(
1023                     (struct ioctl_gntdev_unmap_notify*) data);
1024                 break;
1025         case IOCTL_GNTDEV_ALLOC_GREF:
1026                 error = gntdev_alloc_gref(
1027                     (struct ioctl_gntdev_alloc_gref*) data);
1028                 break;
1029         case IOCTL_GNTDEV_DEALLOC_GREF:
1030                 error = gntdev_dealloc_gref(
1031                     (struct ioctl_gntdev_dealloc_gref*) data);
1032                 break;
1033         case IOCTL_GNTDEV_MAP_GRANT_REF:
1034                 error = gntdev_map_grant_ref(
1035                     (struct ioctl_gntdev_map_grant_ref*) data);
1036                 break;
1037         case IOCTL_GNTDEV_UNMAP_GRANT_REF:
1038                 error = gntdev_unmap_grant_ref(
1039                     (struct ioctl_gntdev_unmap_grant_ref*) data);
1040                 break;
1041         case IOCTL_GNTDEV_GET_OFFSET_FOR_VADDR:
1042                 error = gntdev_get_offset_for_vaddr(
1043                     (struct ioctl_gntdev_get_offset_for_vaddr*) data, td);
1044                 break;
1045         default:
1046                 error = ENOSYS;
1047                 break;
1048         }
1049
1050         return (error);
1051 }
1052
1053 /*
1054  * MMAP an allocated grant into user memory.
1055  * Please note, that the grants must not already be mmapped, otherwise
1056  * this function will fail.
1057  */
1058 static int
1059 mmap_gref(struct per_user_data *priv_user, struct gntdev_gref *gref_start,
1060     uint32_t count, vm_size_t size, struct vm_object **object)
1061 {
1062         vm_object_t mem_obj;
1063         struct gntdev_gref *gref;
1064
1065         mem_obj = vm_object_allocate(OBJT_PHYS, size);
1066         if (mem_obj == NULL)
1067                 return (ENOMEM);
1068
1069         mtx_lock(&priv_user->user_data_lock);
1070         VM_OBJECT_WLOCK(mem_obj);
1071         for (gref = gref_start; gref != NULL && count > 0; gref =
1072             RB_NEXT(gref_tree_head, &priv_user->gref_tree, gref)) {
1073                 if (gref->page->object)
1074                         break;
1075
1076                 vm_page_insert(gref->page, mem_obj,
1077                     UOFF_TO_IDX(gref->file_index));
1078
1079                 count--;
1080         }
1081         VM_OBJECT_WUNLOCK(mem_obj);
1082         mtx_unlock(&priv_user->user_data_lock);
1083
1084         if (count) {
1085                 vm_object_deallocate(mem_obj);
1086                 return (EINVAL);
1087         }
1088
1089         *object = mem_obj;
1090
1091         return (0);
1092
1093 }
1094
1095 /*
1096  * MMAP a mapped grant into user memory.
1097  */
1098 static int
1099 mmap_gmap(struct per_user_data *priv_user, struct gntdev_gmap *gmap_start,
1100     vm_ooffset_t *offset, vm_size_t size, struct vm_object **object, int nprot)
1101 {
1102         uint32_t i;
1103         int error;
1104
1105         /*
1106          * The grant map hypercall might already be done.
1107          * If that is the case, increase a reference to the
1108          * vm object and return the already allocated object.
1109          */
1110         if (gmap_start->map) {
1111                 vm_object_reference(gmap_start->map->mem);
1112                 *object = gmap_start->map->mem;
1113                 return (0);
1114         }
1115
1116         gmap_start->map = malloc(sizeof(*(gmap_start->map)), M_GNTDEV,
1117             M_WAITOK | M_ZERO);
1118
1119         /* Allocate the xen pseudo physical memory resource. */
1120         gmap_start->map->pseudo_phys_res_id = 0;
1121         gmap_start->map->pseudo_phys_res = xenmem_alloc(gntdev_dev,
1122             &gmap_start->map->pseudo_phys_res_id, size);
1123         if (gmap_start->map->pseudo_phys_res == NULL) {
1124                 free(gmap_start->map, M_GNTDEV);
1125                 gmap_start->map = NULL;
1126                 return (ENOMEM);
1127         }
1128         gmap_start->map->phys_base_addr =
1129             rman_get_start(gmap_start->map->pseudo_phys_res);
1130
1131         /* Allocate the mgtdevice pager. */
1132         gmap_start->map->mem = cdev_pager_allocate(gmap_start, OBJT_MGTDEVICE,
1133             &gntdev_gmap_pg_ops, size, nprot, *offset, NULL);
1134         if (gmap_start->map->mem == NULL) {
1135                 xenmem_free(gntdev_dev, gmap_start->map->pseudo_phys_res_id,
1136                     gmap_start->map->pseudo_phys_res);
1137                 free(gmap_start->map, M_GNTDEV);
1138                 gmap_start->map = NULL;
1139                 return (ENOMEM);
1140         }
1141
1142         for (i = 0; i < gmap_start->count; i++) {
1143                 gmap_start->grant_map_ops[i].host_addr =
1144                     gmap_start->map->phys_base_addr + i * PAGE_SIZE;
1145
1146                 if ((nprot & PROT_WRITE) == 0)
1147                         gmap_start->grant_map_ops[i].flags |= GNTMAP_readonly;
1148         }
1149         /* Make the MAP hypercall. */
1150         error = HYPERVISOR_grant_table_op(GNTTABOP_map_grant_ref,
1151             gmap_start->grant_map_ops, gmap_start->count);
1152         if (error != 0) {
1153                 /*
1154                  * Deallocate pager.
1155                  * Pager deallocation will automatically take care of
1156                  * xenmem deallocation, etc.
1157                  */
1158                 vm_object_deallocate(gmap_start->map->mem);
1159
1160                 return (EINVAL);
1161         }
1162
1163         /* Retry EAGAIN maps. */
1164         for (i = 0; i < gmap_start->count; i++) {
1165                 int delay = 1;
1166                 while (delay < 256 &&
1167                     gmap_start->grant_map_ops[i].status == GNTST_eagain) {
1168                         HYPERVISOR_grant_table_op( GNTTABOP_map_grant_ref,
1169                             &gmap_start->grant_map_ops[i], 1);
1170                         pause(("gntmap"), delay * SBT_1MS);
1171                         delay++;
1172                 }
1173                 if (gmap_start->grant_map_ops[i].status == GNTST_eagain)
1174                         gmap_start->grant_map_ops[i].status = GNTST_bad_page;
1175
1176                 if (gmap_start->grant_map_ops[i].status != GNTST_okay) {
1177                         /*
1178                          * Deallocate pager.
1179                          * Pager deallocation will automatically take care of
1180                          * xenmem deallocation, notification, unmap hypercall,
1181                          * etc.
1182                          */
1183                         vm_object_deallocate(gmap_start->map->mem);
1184
1185                         return (EINVAL);
1186                 }
1187         }
1188
1189         /*
1190          * Add a reference to the vm object. We do not want
1191          * the vm object to be deleted when all the mmaps are
1192          * unmapped, because it may be re-mmapped. Instead,
1193          * we want the object to be deleted, when along with
1194          * munmaps, we have also processed the unmap-ioctl.
1195          */
1196         vm_object_reference(gmap_start->map->mem);
1197
1198         *object = gmap_start->map->mem;
1199
1200         return (0);
1201 }
1202
1203 static int
1204 gntdev_mmap_single(struct cdev *cdev, vm_ooffset_t *offset, vm_size_t size,
1205     struct vm_object **object, int nprot)
1206 {
1207         int error;
1208         uint32_t count;
1209         struct gntdev_gref *gref_start;
1210         struct gntdev_gmap *gmap_start;
1211         struct per_user_data *priv_user;
1212
1213         error = devfs_get_cdevpriv((void**) &priv_user);
1214         if (error != 0)
1215                 return (EINVAL);
1216
1217         count = UOFF_TO_IDX(size);
1218
1219         gref_start = gntdev_find_grefs(priv_user, *offset, count);
1220         if (gref_start) {
1221                 error = mmap_gref(priv_user, gref_start, count, size, object);
1222                 return (error);
1223         }
1224
1225         gmap_start = gntdev_find_gmap(priv_user, *offset, count);
1226         if (gmap_start) {
1227                 error = mmap_gmap(priv_user, gmap_start, offset, size, object,
1228                     nprot);
1229                 return (error);
1230         }
1231
1232         return (EINVAL);
1233 }
1234
1235 /*------------------ Private Device Attachment Functions  --------------------*/
1236 static void
1237 gntdev_identify(driver_t *driver, device_t parent)
1238 {
1239
1240         KASSERT((xen_domain()),
1241             ("Trying to attach gntdev device on non Xen domain"));
1242
1243         if (BUS_ADD_CHILD(parent, 0, "gntdev", 0) == NULL)
1244                 panic("unable to attach gntdev user-space device");
1245 }
1246
1247 static int
1248 gntdev_probe(device_t dev)
1249 {
1250
1251         gntdev_dev = dev;
1252         device_set_desc(dev, "Xen grant-table user-space device");
1253         return (BUS_PROBE_NOWILDCARD);
1254 }
1255
1256 static int
1257 gntdev_attach(device_t dev)
1258 {
1259
1260         make_dev_credf(MAKEDEV_ETERNAL, &gntdev_devsw, 0, NULL, UID_ROOT,
1261             GID_WHEEL, 0600, "xen/gntdev");
1262         return (0);
1263 }
1264
1265 /*-------------------- Private Device Attachment Data  -----------------------*/
1266 static device_method_t gntdev_methods[] = {
1267         DEVMETHOD(device_identify, gntdev_identify),
1268         DEVMETHOD(device_probe, gntdev_probe),
1269         DEVMETHOD(device_attach, gntdev_attach),
1270         DEVMETHOD_END
1271 };
1272
1273 static driver_t gntdev_driver = {
1274         "gntdev",
1275         gntdev_methods,
1276         0,
1277 };
1278
1279 devclass_t gntdev_devclass;
1280
1281 DRIVER_MODULE(gntdev, xenpv, gntdev_driver, gntdev_devclass, 0, 0);
1282 MODULE_DEPEND(gntdev, xenpv, 1, 1, 1);