drivers/infiniband/core/rdma_core.c

   1 /*
   2  * Copyright (c) 2016, Mellanox Technologies inc.  All rights reserved.
   3  *
   4  * This software is available to you under a choice of one of two
   5  * licenses.  You may choose to be licensed under the terms of the GNU
   6  * General Public License (GPL) Version 2, available from the file
   7  * COPYING in the main directory of this source tree, or the
   8  * OpenIB.org BSD license below:
   9  *
  10  *     Redistribution and use in source and binary forms, with or
  11  *     without modification, are permitted provided that the following
  12  *     conditions are met:
  13  *
  14  *      - Redistributions of source code must retain the above
  15  *        copyright notice, this list of conditions and the following
  16  *        disclaimer.
  17  *
  18  *      - Redistributions in binary form must reproduce the above
  19  *        copyright notice, this list of conditions and the following
  20  *        disclaimer in the documentation and/or other materials
  21  *        provided with the distribution.
  22  *
  23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  27  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  28  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  30  * SOFTWARE.
  31  */
  32
  33 #include <linux/file.h>
  34 #include <linux/anon_inodes.h>
  35 #include <linux/sched/mm.h>
  36 #include <rdma/ib_verbs.h>
  37 #include <rdma/uverbs_types.h>
  38 #include <linux/rcupdate.h>
  39 #include <rdma/uverbs_ioctl.h>
  40 #include <rdma/rdma_user_ioctl.h>
  41 #include "uverbs.h"
  42 #include "core_priv.h"
  43 #include "rdma_core.h"
  44
  45 static void uverbs_uobject_free(struct kref *ref)
  46 {
  47         kfree_rcu(container_of(ref, struct ib_uobject, ref), rcu);
  48 }
  49
  50 /*
  51  * In order to indicate we no longer needs this uobject, uverbs_uobject_put
  52  * is called. When the reference count is decreased, the uobject is freed.
  53  * For example, this is used when attaching a completion channel to a CQ.
  54  */
  55 void uverbs_uobject_put(struct ib_uobject *uobject)
  56 {
  57         kref_put(&uobject->ref, uverbs_uobject_free);
  58 }
  59 EXPORT_SYMBOL(uverbs_uobject_put);
  60
  61 static int uverbs_try_lock_object(struct ib_uobject *uobj,
  62                                   enum rdma_lookup_mode mode)
  63 {
  64         /*
  65          * When a shared access is required, we use a positive counter. Each
  66          * shared access request checks that the value != -1 and increment it.
  67          * Exclusive access is required for operations like write or destroy.
  68          * In exclusive access mode, we check that the counter is zero (nobody
  69          * claimed this object) and we set it to -1. Releasing a shared access
  70          * lock is done simply by decreasing the counter. As for exclusive
  71          * access locks, since only a single one of them is is allowed
  72          * concurrently, setting the counter to zero is enough for releasing
  73          * this lock.
  74          */
  75         switch (mode) {
  76         case UVERBS_LOOKUP_READ:
  77                 return atomic_fetch_add_unless(&uobj->usecnt, 1, -1) == -1 ?
  78                         -EBUSY : 0;
  79         case UVERBS_LOOKUP_WRITE:
  80                 /* lock is exclusive */
  81                 return atomic_cmpxchg(&uobj->usecnt, 0, -1) == 0 ? 0 : -EBUSY;
  82         case UVERBS_LOOKUP_DESTROY:
  83                 return 0;
  84         }
  85         return 0;
  86 }
  87
  88 static void assert_uverbs_usecnt(struct ib_uobject *uobj,
  89                                  enum rdma_lookup_mode mode)
  90 {
  91 #ifdef CONFIG_LOCKDEP
  92         switch (mode) {
  93         case UVERBS_LOOKUP_READ:
  94                 WARN_ON(atomic_read(&uobj->usecnt) <= 0);
  95                 break;
  96         case UVERBS_LOOKUP_WRITE:
  97                 WARN_ON(atomic_read(&uobj->usecnt) != -1);
  98                 break;
  99         case UVERBS_LOOKUP_DESTROY:
 100                 break;
 101         }
 102 #endif
 103 }
 104
 105 /*
 106  * This must be called with the hw_destroy_rwsem locked for read or write,
 107  * also the uobject itself must be locked for write.
 108  *
 109  * Upon return the HW object is guaranteed to be destroyed.
 110  *
 111  * For RDMA_REMOVE_ABORT, the hw_destroy_rwsem is not required to be held,
 112  * however the type's allocat_commit function cannot have been called and the
 113  * uobject cannot be on the uobjects_lists
 114  *
 115  * For RDMA_REMOVE_DESTROY the caller shold be holding a kref (eg via
 116  * rdma_lookup_get_uobject) and the object is left in a state where the caller
 117  * needs to call rdma_lookup_put_uobject.
 118  *
 119  * For all other destroy modes this function internally unlocks the uobject
 120  * and consumes the kref on the uobj.
 121  */
 122 static int uverbs_destroy_uobject(struct ib_uobject *uobj,
 123                                   enum rdma_remove_reason reason,
 124                                   struct uverbs_attr_bundle *attrs)
 125 {
 126         struct ib_uverbs_file *ufile = attrs->ufile;
 127         unsigned long flags;
 128         int ret;
 129
 130         lockdep_assert_held(&ufile->hw_destroy_rwsem);
 131         assert_uverbs_usecnt(uobj, UVERBS_LOOKUP_WRITE);
 132
 133         if (reason == RDMA_REMOVE_ABORT) {
 134                 WARN_ON(!list_empty(&uobj->list));
 135                 WARN_ON(!uobj->context);
 136                 uobj->uapi_object->type_class->alloc_abort(uobj);
 137         } else if (uobj->object) {
 138                 ret = uobj->uapi_object->type_class->destroy_hw(uobj, reason,
 139                                                                 attrs);
 140                 if (ret) {
 141                         if (ib_is_destroy_retryable(ret, reason, uobj))
 142                                 return ret;
 143
 144                         /* Nothing to be done, dangle the memory and move on */
 145                         WARN(true,
 146                              "ib_uverbs: failed to remove uobject id %d, driver err=%d",
 147                              uobj->id, ret);
 148                 }
 149
 150                 uobj->object = NULL;
 151         }
 152
 153         uobj->context = NULL;
 154
 155         /*
 156          * For DESTROY the usecnt is held write locked, the caller is expected
 157          * to put it unlock and put the object when done with it. Only DESTROY
 158          * can remove the IDR handle.
 159          */
 160         if (reason != RDMA_REMOVE_DESTROY)
 161                 atomic_set(&uobj->usecnt, 0);
 162         else
 163                 uobj->uapi_object->type_class->remove_handle(uobj);
 164
 165         if (!list_empty(&uobj->list)) {
 166                 spin_lock_irqsave(&ufile->uobjects_lock, flags);
 167                 list_del_init(&uobj->list);
 168                 spin_unlock_irqrestore(&ufile->uobjects_lock, flags);
 169
 170                 /*
 171                  * Pairs with the get in rdma_alloc_commit_uobject(), could
 172                  * destroy uobj.
 173                  */
 174                 uverbs_uobject_put(uobj);
 175         }
 176
 177         /*
 178          * When aborting the stack kref remains owned by the core code, and is
 179          * not transferred into the type. Pairs with the get in alloc_uobj
 180          */
 181         if (reason == RDMA_REMOVE_ABORT)
 182                 uverbs_uobject_put(uobj);
 183
 184         return 0;
 185 }
 186
 187 /*
 188  * This calls uverbs_destroy_uobject() using the RDMA_REMOVE_DESTROY
 189  * sequence. It should only be used from command callbacks. On success the
 190  * caller must pair this with rdma_lookup_put_uobject(LOOKUP_WRITE). This
 191  * version requires the caller to have already obtained an
 192  * LOOKUP_DESTROY uobject kref.
 193  */
 194 int uobj_destroy(struct ib_uobject *uobj, struct uverbs_attr_bundle *attrs)
 195 {
 196         struct ib_uverbs_file *ufile = attrs->ufile;
 197         int ret;
 198
 199         down_read(&ufile->hw_destroy_rwsem);
 200
 201         ret = uverbs_try_lock_object(uobj, UVERBS_LOOKUP_WRITE);
 202         if (ret)
 203                 goto out_unlock;
 204
 205         ret = uverbs_destroy_uobject(uobj, RDMA_REMOVE_DESTROY, attrs);
 206         if (ret) {
 207                 atomic_set(&uobj->usecnt, 0);
 208                 goto out_unlock;
 209         }
 210
 211 out_unlock:
 212         up_read(&ufile->hw_destroy_rwsem);
 213         return ret;
 214 }
 215
 216 /*
 217  * uobj_get_destroy destroys the HW object and returns a handle to the uobj
 218  * with a NULL object pointer. The caller must pair this with
 219  * uverbs_put_destroy.
 220  */
 221 struct ib_uobject *__uobj_get_destroy(const struct uverbs_api_object *obj,
 222                                       u32 id, struct uverbs_attr_bundle *attrs)
 223 {
 224         struct ib_uobject *uobj;
 225         int ret;
 226
 227         uobj = rdma_lookup_get_uobject(obj, attrs->ufile, id,
 228                                        UVERBS_LOOKUP_DESTROY, attrs);
 229         if (IS_ERR(uobj))
 230                 return uobj;
 231
 232         ret = uobj_destroy(uobj, attrs);
 233         if (ret) {
 234                 rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_DESTROY);
 235                 return ERR_PTR(ret);
 236         }
 237
 238         return uobj;
 239 }
 240
 241 /*
 242  * Does both uobj_get_destroy() and uobj_put_destroy().  Returns 0 on success
 243  * (negative errno on failure). For use by callers that do not need the uobj.
 244  */
 245 int __uobj_perform_destroy(const struct uverbs_api_object *obj, u32 id,
 246                            struct uverbs_attr_bundle *attrs)
 247 {
 248         struct ib_uobject *uobj;
 249
 250         uobj = __uobj_get_destroy(obj, id, attrs);
 251         if (IS_ERR(uobj))
 252                 return PTR_ERR(uobj);
 253
 254         rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_WRITE);
 255         return 0;
 256 }
 257
 258 /* alloc_uobj must be undone by uverbs_destroy_uobject() */
 259 static struct ib_uobject *alloc_uobj(struct uverbs_attr_bundle *attrs,
 260                                      const struct uverbs_api_object *obj)
 261 {
 262         struct ib_uverbs_file *ufile = attrs->ufile;
 263         struct ib_uobject *uobj;
 264
 265         if (!attrs->context) {
 266                 struct ib_ucontext *ucontext =
 267                         ib_uverbs_get_ucontext_file(ufile);
 268
 269                 if (IS_ERR(ucontext))
 270                         return ERR_CAST(ucontext);
 271                 attrs->context = ucontext;
 272         }
 273
 274         uobj = kzalloc(obj->type_attrs->obj_size, GFP_KERNEL);
 275         if (!uobj)
 276                 return ERR_PTR(-ENOMEM);
 277         /*
 278          * user_handle should be filled by the handler,
 279          * The object is added to the list in the commit stage.
 280          */
 281         uobj->ufile = ufile;
 282         uobj->context = attrs->context;
 283         INIT_LIST_HEAD(&uobj->list);
 284         uobj->uapi_object = obj;
 285         /*
 286          * Allocated objects start out as write locked to deny any other
 287          * syscalls from accessing them until they are committed. See
 288          * rdma_alloc_commit_uobject
 289          */
 290         atomic_set(&uobj->usecnt, -1);
 291         kref_init(&uobj->ref);
 292
 293         return uobj;
 294 }
 295
 296 static int idr_add_uobj(struct ib_uobject *uobj)
 297 {
 298        /*
 299         * We start with allocating an idr pointing to NULL. This represents an
 300         * object which isn't initialized yet. We'll replace it later on with
 301         * the real object once we commit.
 302         */
 303         return xa_alloc(&uobj->ufile->idr, &uobj->id, NULL, xa_limit_32b,
 304                         GFP_KERNEL);
 305 }
 306
 307 /* Returns the ib_uobject or an error. The caller should check for IS_ERR. */
 308 static struct ib_uobject *
 309 lookup_get_idr_uobject(const struct uverbs_api_object *obj,
 310                        struct ib_uverbs_file *ufile, s64 id,
 311                        enum rdma_lookup_mode mode)
 312 {
 313         struct ib_uobject *uobj;
 314
 315         if (id < 0 || id > ULONG_MAX)
 316                 return ERR_PTR(-EINVAL);
 317
 318         rcu_read_lock();
 319         /*
 320          * The idr_find is guaranteed to return a pointer to something that
 321          * isn't freed yet, or NULL, as the free after idr_remove goes through
 322          * kfree_rcu(). However the object may still have been released and
 323          * kfree() could be called at any time.
 324          */
 325         uobj = xa_load(&ufile->idr, id);
 326         if (!uobj || !kref_get_unless_zero(&uobj->ref))
 327                 uobj = ERR_PTR(-ENOENT);
 328         rcu_read_unlock();
 329         return uobj;
 330 }
 331
 332 static struct ib_uobject *
 333 lookup_get_fd_uobject(const struct uverbs_api_object *obj,
 334                       struct ib_uverbs_file *ufile, s64 id,
 335                       enum rdma_lookup_mode mode)
 336 {
 337         const struct uverbs_obj_fd_type *fd_type;
 338         struct file *f;
 339         struct ib_uobject *uobject;
 340         int fdno = id;
 341
 342         if (fdno != id)
 343                 return ERR_PTR(-EINVAL);
 344
 345         if (mode != UVERBS_LOOKUP_READ)
 346                 return ERR_PTR(-EOPNOTSUPP);
 347
 348         if (!obj->type_attrs)
 349                 return ERR_PTR(-EIO);
 350         fd_type =
 351                 container_of(obj->type_attrs, struct uverbs_obj_fd_type, type);
 352
 353         f = fget(fdno);
 354         if (!f)
 355                 return ERR_PTR(-EBADF);
 356
 357         uobject = f->private_data;
 358         /*
 359          * fget(id) ensures we are not currently running
 360          * uverbs_uobject_fd_release(), and the caller is expected to ensure
 361          * that release is never done while a call to lookup is possible.
 362          */
 363         if (f->f_op != fd_type->fops) {
 364                 fput(f);
 365                 return ERR_PTR(-EBADF);
 366         }
 367
 368         uverbs_uobject_get(uobject);
 369         return uobject;
 370 }
 371
 372 struct ib_uobject *rdma_lookup_get_uobject(const struct uverbs_api_object *obj,
 373                                            struct ib_uverbs_file *ufile, s64 id,
 374                                            enum rdma_lookup_mode mode,
 375                                            struct uverbs_attr_bundle *attrs)
 376 {
 377         struct ib_uobject *uobj;
 378         int ret;
 379
 380         if (obj == ERR_PTR(-ENOMSG)) {
 381                 /* must be UVERBS_IDR_ANY_OBJECT, see uapi_get_object() */
 382                 uobj = lookup_get_idr_uobject(NULL, ufile, id, mode);
 383                 if (IS_ERR(uobj))
 384                         return uobj;
 385         } else {
 386                 if (IS_ERR(obj))
 387                         return ERR_PTR(-EINVAL);
 388
 389                 uobj = obj->type_class->lookup_get(obj, ufile, id, mode);
 390                 if (IS_ERR(uobj))
 391                         return uobj;
 392
 393                 if (uobj->uapi_object != obj) {
 394                         ret = -EINVAL;
 395                         goto free;
 396                 }
 397         }
 398
 399         /*
 400          * If we have been disassociated block every command except for
 401          * DESTROY based commands.
 402          */
 403         if (mode != UVERBS_LOOKUP_DESTROY &&
 404             !srcu_dereference(ufile->device->ib_dev,
 405                               &ufile->device->disassociate_srcu)) {
 406                 ret = -EIO;
 407                 goto free;
 408         }
 409
 410         ret = uverbs_try_lock_object(uobj, mode);
 411         if (ret)
 412                 goto free;
 413         if (attrs)
 414                 attrs->context = uobj->context;
 415
 416         return uobj;
 417 free:
 418         uobj->uapi_object->type_class->lookup_put(uobj, mode);
 419         uverbs_uobject_put(uobj);
 420         return ERR_PTR(ret);
 421 }
 422
 423 static struct ib_uobject *
 424 alloc_begin_idr_uobject(const struct uverbs_api_object *obj,
 425                         struct uverbs_attr_bundle *attrs)
 426 {
 427         int ret;
 428         struct ib_uobject *uobj;
 429
 430         uobj = alloc_uobj(attrs, obj);
 431         if (IS_ERR(uobj))
 432                 return uobj;
 433
 434         ret = idr_add_uobj(uobj);
 435         if (ret)
 436                 goto uobj_put;
 437
 438         ret = ib_rdmacg_try_charge(&uobj->cg_obj, uobj->context->device,
 439                                    RDMACG_RESOURCE_HCA_OBJECT);
 440         if (ret)
 441                 goto remove;
 442
 443         return uobj;
 444
 445 remove:
 446         xa_erase(&attrs->ufile->idr, uobj->id);
 447 uobj_put:
 448         uverbs_uobject_put(uobj);
 449         return ERR_PTR(ret);
 450 }
 451
 452 static struct ib_uobject *
 453 alloc_begin_fd_uobject(const struct uverbs_api_object *obj,
 454                        struct uverbs_attr_bundle *attrs)
 455 {
 456         const struct uverbs_obj_fd_type *fd_type =
 457                 container_of(obj->type_attrs, struct uverbs_obj_fd_type, type);
 458         int new_fd;
 459         struct ib_uobject *uobj;
 460         struct file *filp;
 461
 462         if (WARN_ON(fd_type->fops->release != &uverbs_uobject_fd_release))
 463                 return ERR_PTR(-EINVAL);
 464
 465         new_fd = get_unused_fd_flags(O_CLOEXEC);
 466         if (new_fd < 0)
 467                 return ERR_PTR(new_fd);
 468
 469         uobj = alloc_uobj(attrs, obj);
 470         if (IS_ERR(uobj))
 471                 goto err_fd;
 472
 473         /* Note that uverbs_uobject_fd_release() is called during abort */
 474         filp = anon_inode_getfile(fd_type->name, fd_type->fops, NULL,
 475                                   fd_type->flags);
 476         if (IS_ERR(filp)) {
 477                 uobj = ERR_CAST(filp);
 478                 goto err_uobj;
 479         }
 480         uobj->object = filp;
 481
 482         uobj->id = new_fd;
 483         return uobj;
 484
 485 err_uobj:
 486         uverbs_uobject_put(uobj);
 487 err_fd:
 488         put_unused_fd(new_fd);
 489         return uobj;
 490 }
 491
 492 struct ib_uobject *rdma_alloc_begin_uobject(const struct uverbs_api_object *obj,
 493                                             struct uverbs_attr_bundle *attrs)
 494 {
 495         struct ib_uverbs_file *ufile = attrs->ufile;
 496         struct ib_uobject *ret;
 497
 498         if (IS_ERR(obj))
 499                 return ERR_PTR(-EINVAL);
 500
 501         /*
 502          * The hw_destroy_rwsem is held across the entire object creation and
 503          * released during rdma_alloc_commit_uobject or
 504          * rdma_alloc_abort_uobject
 505          */
 506         if (!down_read_trylock(&ufile->hw_destroy_rwsem))
 507                 return ERR_PTR(-EIO);
 508
 509         ret = obj->type_class->alloc_begin(obj, attrs);
 510         if (IS_ERR(ret)) {
 511                 up_read(&ufile->hw_destroy_rwsem);
 512                 return ret;
 513         }
 514         return ret;
 515 }
 516
 517 static void alloc_abort_idr_uobject(struct ib_uobject *uobj)
 518 {
 519         ib_rdmacg_uncharge(&uobj->cg_obj, uobj->context->device,
 520                            RDMACG_RESOURCE_HCA_OBJECT);
 521
 522         xa_erase(&uobj->ufile->idr, uobj->id);
 523 }
 524
 525 static int __must_check destroy_hw_idr_uobject(struct ib_uobject *uobj,
 526                                                enum rdma_remove_reason why,
 527                                                struct uverbs_attr_bundle *attrs)
 528 {
 529         const struct uverbs_obj_idr_type *idr_type =
 530                 container_of(uobj->uapi_object->type_attrs,
 531                              struct uverbs_obj_idr_type, type);
 532         int ret = idr_type->destroy_object(uobj, why, attrs);
 533
 534         /*
 535          * We can only fail gracefully if the user requested to destroy the
 536          * object or when a retry may be called upon an error.
 537          * In the rest of the cases, just remove whatever you can.
 538          */
 539         if (ib_is_destroy_retryable(ret, why, uobj))
 540                 return ret;
 541
 542         if (why == RDMA_REMOVE_ABORT)
 543                 return 0;
 544
 545         ib_rdmacg_uncharge(&uobj->cg_obj, uobj->context->device,
 546                            RDMACG_RESOURCE_HCA_OBJECT);
 547
 548         return 0;
 549 }
 550
 551 static void remove_handle_idr_uobject(struct ib_uobject *uobj)
 552 {
 553         xa_erase(&uobj->ufile->idr, uobj->id);
 554         /* Matches the kref in alloc_commit_idr_uobject */
 555         uverbs_uobject_put(uobj);
 556 }
 557
 558 static void alloc_abort_fd_uobject(struct ib_uobject *uobj)
 559 {
 560         struct file *filp = uobj->object;
 561
 562         fput(filp);
 563         put_unused_fd(uobj->id);
 564 }
 565
 566 static int __must_check destroy_hw_fd_uobject(struct ib_uobject *uobj,
 567                                               enum rdma_remove_reason why,
 568                                               struct uverbs_attr_bundle *attrs)
 569 {
 570         const struct uverbs_obj_fd_type *fd_type = container_of(
 571                 uobj->uapi_object->type_attrs, struct uverbs_obj_fd_type, type);
 572         int ret = fd_type->destroy_object(uobj, why);
 573
 574         if (ib_is_destroy_retryable(ret, why, uobj))
 575                 return ret;
 576
 577         return 0;
 578 }
 579
 580 static void remove_handle_fd_uobject(struct ib_uobject *uobj)
 581 {
 582 }
 583
 584 static void alloc_commit_idr_uobject(struct ib_uobject *uobj)
 585 {
 586         struct ib_uverbs_file *ufile = uobj->ufile;
 587         void *old;
 588
 589         /*
 590          * We already allocated this IDR with a NULL object, so
 591          * this shouldn't fail.
 592          *
 593          * NOTE: Storing the uobj transfers our kref on uobj to the XArray.
 594          * It will be put by remove_commit_idr_uobject()
 595          */
 596         old = xa_store(&ufile->idr, uobj->id, uobj, GFP_KERNEL);
 597         WARN_ON(old != NULL);
 598 }
 599
 600 static void alloc_commit_fd_uobject(struct ib_uobject *uobj)
 601 {
 602         int fd = uobj->id;
 603         struct file *filp = uobj->object;
 604
 605         /* Matching put will be done in uverbs_uobject_fd_release() */
 606         kref_get(&uobj->ufile->ref);
 607
 608         /* This shouldn't be used anymore. Use the file object instead */
 609         uobj->id = 0;
 610
 611         /*
 612          * NOTE: Once we install the file we loose ownership of our kref on
 613          * uobj. It will be put by uverbs_uobject_fd_release()
 614          */
 615         filp->private_data = uobj;
 616         fd_install(fd, filp);
 617 }
 618
 619 /*
 620  * In all cases rdma_alloc_commit_uobject() consumes the kref to uobj and the
 621  * caller can no longer assume uobj is valid. If this function fails it
 622  * destroys the uboject, including the attached HW object.
 623  */
 624 void rdma_alloc_commit_uobject(struct ib_uobject *uobj,
 625                                struct uverbs_attr_bundle *attrs)
 626 {
 627         struct ib_uverbs_file *ufile = attrs->ufile;
 628
 629         /* alloc_commit consumes the uobj kref */
 630         uobj->uapi_object->type_class->alloc_commit(uobj);
 631
 632         /* kref is held so long as the uobj is on the uobj list. */
 633         uverbs_uobject_get(uobj);
 634         spin_lock_irq(&ufile->uobjects_lock);
 635         list_add(&uobj->list, &ufile->uobjects);
 636         spin_unlock_irq(&ufile->uobjects_lock);
 637
 638         /* matches atomic_set(-1) in alloc_uobj */
 639         atomic_set(&uobj->usecnt, 0);
 640
 641         /* Matches the down_read in rdma_alloc_begin_uobject */
 642         up_read(&ufile->hw_destroy_rwsem);
 643 }
 644
 645 /*
 646  * This consumes the kref for uobj. It is up to the caller to unwind the HW
 647  * object and anything else connected to uobj before calling this.
 648  */
 649 void rdma_alloc_abort_uobject(struct ib_uobject *uobj,
 650                               struct uverbs_attr_bundle *attrs)
 651 {
 652         struct ib_uverbs_file *ufile = uobj->ufile;
 653
 654         uverbs_destroy_uobject(uobj, RDMA_REMOVE_ABORT, attrs);
 655
 656         /* Matches the down_read in rdma_alloc_begin_uobject */
 657         up_read(&ufile->hw_destroy_rwsem);
 658 }
 659
 660 static void lookup_put_idr_uobject(struct ib_uobject *uobj,
 661                                    enum rdma_lookup_mode mode)
 662 {
 663 }
 664
 665 static void lookup_put_fd_uobject(struct ib_uobject *uobj,
 666                                   enum rdma_lookup_mode mode)
 667 {
 668         struct file *filp = uobj->object;
 669
 670         WARN_ON(mode != UVERBS_LOOKUP_READ);
 671         /*
 672          * This indirectly calls uverbs_uobject_fd_release() and free the
 673          * object
 674          */
 675         fput(filp);
 676 }
 677
 678 void rdma_lookup_put_uobject(struct ib_uobject *uobj,
 679                              enum rdma_lookup_mode mode)
 680 {
 681         assert_uverbs_usecnt(uobj, mode);
 682         uobj->uapi_object->type_class->lookup_put(uobj, mode);
 683         /*
 684          * In order to unlock an object, either decrease its usecnt for
 685          * read access or zero it in case of exclusive access. See
 686          * uverbs_try_lock_object for locking schema information.
 687          */
 688         switch (mode) {
 689         case UVERBS_LOOKUP_READ:
 690                 atomic_dec(&uobj->usecnt);
 691                 break;
 692         case UVERBS_LOOKUP_WRITE:
 693                 atomic_set(&uobj->usecnt, 0);
 694                 break;
 695         case UVERBS_LOOKUP_DESTROY:
 696                 break;
 697         }
 698
 699         /* Pairs with the kref obtained by type->lookup_get */
 700         uverbs_uobject_put(uobj);
 701 }
 702
 703 void setup_ufile_idr_uobject(struct ib_uverbs_file *ufile)
 704 {
 705         xa_init_flags(&ufile->idr, XA_FLAGS_ALLOC);
 706 }
 707
 708 void release_ufile_idr_uobject(struct ib_uverbs_file *ufile)
 709 {
 710         struct ib_uobject *entry;
 711         unsigned long id;
 712
 713         /*
 714          * At this point uverbs_cleanup_ufile() is guaranteed to have run, and
 715          * there are no HW objects left, however the xarray is still populated
 716          * with anything that has not been cleaned up by userspace. Since the
 717          * kref on ufile is 0, nothing is allowed to call lookup_get.
 718          *
 719          * This is an optimized equivalent to remove_handle_idr_uobject
 720          */
 721         xa_for_each(&ufile->idr, id, entry) {
 722                 WARN_ON(entry->object);
 723                 uverbs_uobject_put(entry);
 724         }
 725
 726         xa_destroy(&ufile->idr);
 727 }
 728
 729 const struct uverbs_obj_type_class uverbs_idr_class = {
 730         .alloc_begin = alloc_begin_idr_uobject,
 731         .lookup_get = lookup_get_idr_uobject,
 732         .alloc_commit = alloc_commit_idr_uobject,
 733         .alloc_abort = alloc_abort_idr_uobject,
 734         .lookup_put = lookup_put_idr_uobject,
 735         .destroy_hw = destroy_hw_idr_uobject,
 736         .remove_handle = remove_handle_idr_uobject,
 737 };
 738 EXPORT_SYMBOL(uverbs_idr_class);
 739
 740 /*
 741  * Users of UVERBS_TYPE_ALLOC_FD should set this function as the struct
 742  * file_operations release method.
 743  */
 744 int uverbs_uobject_fd_release(struct inode *inode, struct file *filp)
 745 {
 746         struct ib_uverbs_file *ufile;
 747         struct ib_uobject *uobj;
 748
 749         /*
 750          * This can only happen if the fput came from alloc_abort_fd_uobject()
 751          */
 752         if (!filp->private_data)
 753                 return 0;
 754         uobj = filp->private_data;
 755         ufile = uobj->ufile;
 756
 757         if (down_read_trylock(&ufile->hw_destroy_rwsem)) {
 758                 struct uverbs_attr_bundle attrs = {
 759                         .context = uobj->context,
 760                         .ufile = ufile,
 761                 };
 762
 763                 /*
 764                  * lookup_get_fd_uobject holds the kref on the struct file any
 765                  * time a FD uobj is locked, which prevents this release
 766                  * method from being invoked. Meaning we can always get the
 767                  * write lock here, or we have a kernel bug.
 768                  */
 769                 WARN_ON(uverbs_try_lock_object(uobj, UVERBS_LOOKUP_WRITE));
 770                 uverbs_destroy_uobject(uobj, RDMA_REMOVE_CLOSE, &attrs);
 771                 up_read(&ufile->hw_destroy_rwsem);
 772         }
 773
 774         /* Matches the get in alloc_commit_fd_uobject() */
 775         kref_put(&ufile->ref, ib_uverbs_release_file);
 776
 777         /* Pairs with filp->private_data in alloc_begin_fd_uobject */
 778         uverbs_uobject_put(uobj);
 779         return 0;
 780 }
 781 EXPORT_SYMBOL(uverbs_uobject_fd_release);
 782
 783 /*
 784  * Drop the ucontext off the ufile and completely disconnect it from the
 785  * ib_device
 786  */
 787 static void ufile_destroy_ucontext(struct ib_uverbs_file *ufile,
 788                                    enum rdma_remove_reason reason)
 789 {
 790         struct ib_ucontext *ucontext = ufile->ucontext;
 791         struct ib_device *ib_dev = ucontext->device;
 792
 793         /*
 794          * If we are closing the FD then the user mmap VMAs must have
 795          * already been destroyed as they hold on to the filep, otherwise
 796          * they need to be zap'd.
 797          */
 798         if (reason == RDMA_REMOVE_DRIVER_REMOVE) {
 799                 uverbs_user_mmap_disassociate(ufile);
 800                 if (ib_dev->ops.disassociate_ucontext)
 801                         ib_dev->ops.disassociate_ucontext(ucontext);
 802         }
 803
 804         ib_rdmacg_uncharge(&ucontext->cg_obj, ib_dev,
 805                            RDMACG_RESOURCE_HCA_HANDLE);
 806
 807         rdma_restrack_del(&ucontext->res);
 808
 809         ib_dev->ops.dealloc_ucontext(ucontext);
 810         WARN_ON(!xa_empty(&ucontext->mmap_xa));
 811         kfree(ucontext);
 812
 813         ufile->ucontext = NULL;
 814 }
 815
 816 static int __uverbs_cleanup_ufile(struct ib_uverbs_file *ufile,
 817                                   enum rdma_remove_reason reason)
 818 {
 819         struct ib_uobject *obj, *next_obj;
 820         int ret = -EINVAL;
 821         struct uverbs_attr_bundle attrs = { .ufile = ufile };
 822
 823         /*
 824          * This shouldn't run while executing other commands on this
 825          * context. Thus, the only thing we should take care of is
 826          * releasing a FD while traversing this list. The FD could be
 827          * closed and released from the _release fop of this FD.
 828          * In order to mitigate this, we add a lock.
 829          * We take and release the lock per traversal in order to let
 830          * other threads (which might still use the FDs) chance to run.
 831          */
 832         list_for_each_entry_safe(obj, next_obj, &ufile->uobjects, list) {
 833                 attrs.context = obj->context;
 834                 /*
 835                  * if we hit this WARN_ON, that means we are
 836                  * racing with a lookup_get.
 837                  */
 838                 WARN_ON(uverbs_try_lock_object(obj, UVERBS_LOOKUP_WRITE));
 839                 if (!uverbs_destroy_uobject(obj, reason, &attrs))
 840                         ret = 0;
 841                 else
 842                         atomic_set(&obj->usecnt, 0);
 843         }
 844         return ret;
 845 }
 846
 847 /*
 848  * Destroy the uncontext and every uobject associated with it.
 849  *
 850  * This is internally locked and can be called in parallel from multiple
 851  * contexts.
 852  */
 853 void uverbs_destroy_ufile_hw(struct ib_uverbs_file *ufile,
 854                              enum rdma_remove_reason reason)
 855 {
 856         down_write(&ufile->hw_destroy_rwsem);
 857
 858         /*
 859          * If a ucontext was never created then we can't have any uobjects to
 860          * cleanup, nothing to do.
 861          */
 862         if (!ufile->ucontext)
 863                 goto done;
 864
 865         ufile->ucontext->closing = true;
 866         ufile->ucontext->cleanup_retryable = true;
 867         while (!list_empty(&ufile->uobjects))
 868                 if (__uverbs_cleanup_ufile(ufile, reason)) {
 869                         /*
 870                          * No entry was cleaned-up successfully during this
 871                          * iteration
 872                          */
 873                         break;
 874                 }
 875
 876         ufile->ucontext->cleanup_retryable = false;
 877         if (!list_empty(&ufile->uobjects))
 878                 __uverbs_cleanup_ufile(ufile, reason);
 879
 880         ufile_destroy_ucontext(ufile, reason);
 881
 882 done:
 883         up_write(&ufile->hw_destroy_rwsem);
 884 }
 885
 886 const struct uverbs_obj_type_class uverbs_fd_class = {
 887         .alloc_begin = alloc_begin_fd_uobject,
 888         .lookup_get = lookup_get_fd_uobject,
 889         .alloc_commit = alloc_commit_fd_uobject,
 890         .alloc_abort = alloc_abort_fd_uobject,
 891         .lookup_put = lookup_put_fd_uobject,
 892         .destroy_hw = destroy_hw_fd_uobject,
 893         .remove_handle = remove_handle_fd_uobject,
 894 };
 895 EXPORT_SYMBOL(uverbs_fd_class);
 896
 897 struct ib_uobject *
 898 uverbs_get_uobject_from_file(u16 object_id, enum uverbs_obj_access access,
 899                              s64 id, struct uverbs_attr_bundle *attrs)
 900 {
 901         const struct uverbs_api_object *obj =
 902                 uapi_get_object(attrs->ufile->device->uapi, object_id);
 903
 904         switch (access) {
 905         case UVERBS_ACCESS_READ:
 906                 return rdma_lookup_get_uobject(obj, attrs->ufile, id,
 907                                                UVERBS_LOOKUP_READ, attrs);
 908         case UVERBS_ACCESS_DESTROY:
 909                 /* Actual destruction is done inside uverbs_handle_method */
 910                 return rdma_lookup_get_uobject(obj, attrs->ufile, id,
 911                                                UVERBS_LOOKUP_DESTROY, attrs);
 912         case UVERBS_ACCESS_WRITE:
 913                 return rdma_lookup_get_uobject(obj, attrs->ufile, id,
 914                                                UVERBS_LOOKUP_WRITE, attrs);
 915         case UVERBS_ACCESS_NEW:
 916                 return rdma_alloc_begin_uobject(obj, attrs);
 917         default:
 918                 WARN_ON(true);
 919                 return ERR_PTR(-EOPNOTSUPP);
 920         }
 921 }
 922
 923 void uverbs_finalize_object(struct ib_uobject *uobj,
 924                             enum uverbs_obj_access access, bool commit,
 925                             struct uverbs_attr_bundle *attrs)
 926 {
 927         /*
 928          * refcounts should be handled at the object level and not at the
 929          * uobject level. Refcounts of the objects themselves are done in
 930          * handlers.
 931          */
 932
 933         switch (access) {
 934         case UVERBS_ACCESS_READ:
 935                 rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_READ);
 936                 break;
 937         case UVERBS_ACCESS_WRITE:
 938                 rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_WRITE);
 939                 break;
 940         case UVERBS_ACCESS_DESTROY:
 941                 if (uobj)
 942                         rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_DESTROY);
 943                 break;
 944         case UVERBS_ACCESS_NEW:
 945                 if (commit)
 946                         rdma_alloc_commit_uobject(uobj, attrs);
 947                 else
 948                         rdma_alloc_abort_uobject(uobj, attrs);
 949                 break;
 950         default:
 951                 WARN_ON(true);
 952         }
 953 }