RDMA/core: Postpone uobject cleanup on failure till FD close
authorLeon Romanovsky <leonro@nvidia.com>
Wed, 4 Nov 2020 14:45:55 +0000 (16:45 +0200)
committerJason Gunthorpe <jgg@nvidia.com>
Thu, 12 Nov 2020 16:32:17 +0000 (12:32 -0400)
Remove the ib_is_destroyable_retryable() concept.

The idea here was to allow the drivers to forcibly clean the HW object
even if they otherwise didn't want to (eg because of usecnt). This was an
attempt to clean up in a world where drivers were not allowed to fail HW
object destruction.

Now that we are going back to allowing HW objects to fail destroy this
doesn't make sense. Instead if a uobject's HW object can't be destroyed it
is left on the uobject list and it is up to uverbs_destroy_ufile_hw() to
clean it. Multiple passes over the uobject list allow hidden dependencies
to be resolved. If that fails the HW driver is broken, throw a WARN_ON and
leak the HW object memory.

All the other tricky failure paths (eg on creation error unwind) have
already been updated to this new model.

Link: https://lore.kernel.org/r/20201104144556.3809085-2-leon@kernel.org
Signed-off-by: Leon Romanovsky <leonro@nvidia.com>
Signed-off-by: Jason Gunthorpe <jgg@nvidia.com>
13 files changed:
drivers/infiniband/core/rdma_core.c
drivers/infiniband/core/uverbs_cmd.c
drivers/infiniband/core/uverbs_std_types.c
drivers/infiniband/core/uverbs_std_types_counters.c
drivers/infiniband/core/uverbs_std_types_cq.c
drivers/infiniband/core/uverbs_std_types_dm.c
drivers/infiniband/core/uverbs_std_types_flow_action.c
drivers/infiniband/core/uverbs_std_types_qp.c
drivers/infiniband/core/uverbs_std_types_srq.c
drivers/infiniband/core/uverbs_std_types_wq.c
drivers/infiniband/hw/mlx5/devx.c
drivers/infiniband/hw/mlx5/fs.c
include/rdma/ib_verbs.h

index ffe11b03724cf51a2deb91e8bfd5b005e6edc516..61fa0a3f8e5eed28048570ed9c26605c8f1e4858 100644 (file)
@@ -137,15 +137,9 @@ static int uverbs_destroy_uobject(struct ib_uobject *uobj,
        } else if (uobj->object) {
                ret = uobj->uapi_object->type_class->destroy_hw(uobj, reason,
                                                                attrs);
-               if (ret) {
-                       if (ib_is_destroy_retryable(ret, reason, uobj))
-                               return ret;
-
-                       /* Nothing to be done, dangle the memory and move on */
-                       WARN(true,
-                            "ib_uverbs: failed to remove uobject id %d, driver err=%d",
-                            uobj->id, ret);
-               }
+               if (ret)
+                       /* Nothing to be done, wait till ucontext will clean it */
+                       return ret;
 
                uobj->object = NULL;
        }
@@ -543,12 +537,7 @@ static int __must_check destroy_hw_idr_uobject(struct ib_uobject *uobj,
                             struct uverbs_obj_idr_type, type);
        int ret = idr_type->destroy_object(uobj, why, attrs);
 
-       /*
-        * We can only fail gracefully if the user requested to destroy the
-        * object or when a retry may be called upon an error.
-        * In the rest of the cases, just remove whatever you can.
-        */
-       if (ib_is_destroy_retryable(ret, why, uobj))
+       if (ret)
                return ret;
 
        if (why == RDMA_REMOVE_ABORT)
@@ -581,12 +570,8 @@ static int __must_check destroy_hw_fd_uobject(struct ib_uobject *uobj,
 {
        const struct uverbs_obj_fd_type *fd_type = container_of(
                uobj->uapi_object->type_attrs, struct uverbs_obj_fd_type, type);
-       int ret = fd_type->destroy_object(uobj, why);
 
-       if (ib_is_destroy_retryable(ret, why, uobj))
-               return ret;
-
-       return 0;
+       return fd_type->destroy_object(uobj, why);
 }
 
 static void remove_handle_fd_uobject(struct ib_uobject *uobj)
@@ -863,11 +848,18 @@ static int __uverbs_cleanup_ufile(struct ib_uverbs_file *ufile,
                 * racing with a lookup_get.
                 */
                WARN_ON(uverbs_try_lock_object(obj, UVERBS_LOOKUP_WRITE));
+               if (reason == RDMA_REMOVE_DRIVER_FAILURE)
+                       obj->object = NULL;
                if (!uverbs_destroy_uobject(obj, reason, &attrs))
                        ret = 0;
                else
                        atomic_set(&obj->usecnt, 0);
        }
+
+       if (reason == RDMA_REMOVE_DRIVER_FAILURE) {
+               WARN_ON(!list_empty(&ufile->uobjects));
+               return 0;
+       }
        return ret;
 }
 
@@ -889,21 +881,12 @@ void uverbs_destroy_ufile_hw(struct ib_uverbs_file *ufile,
        if (!ufile->ucontext)
                goto done;
 
-       ufile->ucontext->cleanup_retryable = true;
-       while (!list_empty(&ufile->uobjects))
-               if (__uverbs_cleanup_ufile(ufile, reason)) {
-                       /*
-                        * No entry was cleaned-up successfully during this
-                        * iteration. It is a driver bug to fail destruction.
-                        */
-                       WARN_ON(!list_empty(&ufile->uobjects));
-                       break;
-               }
-
-       ufile->ucontext->cleanup_retryable = false;
-       if (!list_empty(&ufile->uobjects))
-               __uverbs_cleanup_ufile(ufile, reason);
+       while (!list_empty(&ufile->uobjects) &&
+              !__uverbs_cleanup_ufile(ufile, reason)) {
+       }
 
+       if (WARN_ON(!list_empty(&ufile->uobjects)))
+               __uverbs_cleanup_ufile(ufile, RDMA_REMOVE_DRIVER_FAILURE);
        ufile_destroy_ucontext(ufile, reason);
 
 done:
index 72b209ca77c734cc40ea0d0d39c0501f8655da85..92c9d2a548f31ae42380893cb25a22f258595db9 100644 (file)
@@ -681,8 +681,7 @@ int ib_uverbs_dealloc_xrcd(struct ib_uobject *uobject, struct ib_xrcd *xrcd,
                return 0;
 
        ret = ib_dealloc_xrcd_user(xrcd, &attrs->driver_udata);
-
-       if (ib_is_destroy_retryable(ret, why, uobject)) {
+       if (ret) {
                atomic_inc(&xrcd->usecnt);
                return ret;
        }
@@ -690,7 +689,7 @@ int ib_uverbs_dealloc_xrcd(struct ib_uobject *uobject, struct ib_xrcd *xrcd,
        if (inode)
                xrcd_table_delete(dev, inode);
 
-       return ret;
+       return 0;
 }
 
 static int ib_uverbs_reg_mr(struct uverbs_attr_bundle *attrs)
index 0658101fca004a852556f5f0b22a05685292ddf7..585042ead939286898776c9455d1dfd6615f6bb1 100644 (file)
@@ -88,7 +88,7 @@ static int uverbs_free_rwq_ind_tbl(struct ib_uobject *uobject,
                return -EBUSY;
 
        ret = rwq_ind_tbl->device->ops.destroy_rwq_ind_table(rwq_ind_tbl);
-       if (ib_is_destroy_retryable(ret, why, uobject))
+       if (ret)
                return ret;
 
        for (i = 0; i < table_size; i++)
@@ -96,7 +96,7 @@ static int uverbs_free_rwq_ind_tbl(struct ib_uobject *uobject,
 
        kfree(rwq_ind_tbl);
        kfree(ind_tbl);
-       return ret;
+       return 0;
 }
 
 static int uverbs_free_xrcd(struct ib_uobject *uobject,
@@ -108,9 +108,8 @@ static int uverbs_free_xrcd(struct ib_uobject *uobject,
                container_of(uobject, struct ib_uxrcd_object, uobject);
        int ret;
 
-       ret = ib_destroy_usecnt(&uxrcd->refcnt, why, uobject);
-       if (ret)
-               return ret;
+       if (atomic_read(&uxrcd->refcnt))
+               return -EBUSY;
 
        mutex_lock(&attrs->ufile->device->xrcd_tree_mutex);
        ret = ib_uverbs_dealloc_xrcd(uobject, xrcd, why, attrs);
@@ -124,11 +123,9 @@ static int uverbs_free_pd(struct ib_uobject *uobject,
                          struct uverbs_attr_bundle *attrs)
 {
        struct ib_pd *pd = uobject->object;
-       int ret;
 
-       ret = ib_destroy_usecnt(&pd->usecnt, why, uobject);
-       if (ret)
-               return ret;
+       if (atomic_read(&pd->usecnt))
+               return -EBUSY;
 
        return ib_dealloc_pd_user(pd, &attrs->driver_udata);
 }
index b3c6c066b60100ad97bb4231047c65bd7f7ac8d8..999da9c7986687dc2e8392675ef150c0702d76df 100644 (file)
@@ -42,9 +42,8 @@ static int uverbs_free_counters(struct ib_uobject *uobject,
        struct ib_counters *counters = uobject->object;
        int ret;
 
-       ret = ib_destroy_usecnt(&counters->usecnt, why, uobject);
-       if (ret)
-               return ret;
+       if (atomic_read(&counters->usecnt))
+               return -EBUSY;
 
        ret = counters->device->ops.destroy_counters(counters);
        if (ret)
index 8dabd05988b2378435ea1efe44bbe0a25d53105b..370ad7c83f8804be67081141796b0a05385481ff 100644 (file)
@@ -46,7 +46,7 @@ static int uverbs_free_cq(struct ib_uobject *uobject,
        int ret;
 
        ret = ib_destroy_cq_user(cq, &attrs->driver_udata);
-       if (ib_is_destroy_retryable(ret, why, uobject))
+       if (ret)
                return ret;
 
        ib_uverbs_release_ucq(
@@ -55,7 +55,7 @@ static int uverbs_free_cq(struct ib_uobject *uobject,
                                        ev_queue) :
                           NULL,
                ucq);
-       return ret;
+       return 0;
 }
 
 static int UVERBS_HANDLER(UVERBS_METHOD_CQ_CREATE)(
index d5a1de33c2c9ad3e6328ef35d1173d88a4adc5e5..98c522cf86d6f24cd774d0cce15dc1d5e1b6d24a 100644 (file)
@@ -39,11 +39,9 @@ static int uverbs_free_dm(struct ib_uobject *uobject,
                          struct uverbs_attr_bundle *attrs)
 {
        struct ib_dm *dm = uobject->object;
-       int ret;
 
-       ret = ib_destroy_usecnt(&dm->usecnt, why, uobject);
-       if (ret)
-               return ret;
+       if (atomic_read(&dm->usecnt))
+               return -EBUSY;
 
        return dm->device->ops.dealloc_dm(dm, attrs);
 }
index 459cf165b231e6e5669adff841178c656aa24458..d42ed7ff223e3d8aa5aeece7f012e4d6378a7d70 100644 (file)
@@ -39,11 +39,9 @@ static int uverbs_free_flow_action(struct ib_uobject *uobject,
                                   struct uverbs_attr_bundle *attrs)
 {
        struct ib_flow_action *action = uobject->object;
-       int ret;
 
-       ret = ib_destroy_usecnt(&action->usecnt, why, uobject);
-       if (ret)
-               return ret;
+       if (atomic_read(&action->usecnt))
+               return -EBUSY;
 
        return action->device->ops.destroy_flow_action(action);
 }
index 3bf8dcdfe7eb64e81df2c44405fd1322e3244f39..294cd29d5cede707bfa542d2815c20ff2352cbb3 100644 (file)
@@ -32,14 +32,14 @@ static int uverbs_free_qp(struct ib_uobject *uobject,
        }
 
        ret = ib_destroy_qp_user(qp, &attrs->driver_udata);
-       if (ib_is_destroy_retryable(ret, why, uobject))
+       if (ret)
                return ret;
 
        if (uqp->uxrcd)
                atomic_dec(&uqp->uxrcd->refcnt);
 
        ib_uverbs_release_uevent(&uqp->uevent);
-       return ret;
+       return 0;
 }
 
 static int check_creation_flags(enum ib_qp_type qp_type,
index c0ecbba26bf49fa51749ff080b3a189b8a21f3f1..e5513f828bdc12ff52ed749ea12a5959ebfadec4 100644 (file)
@@ -18,7 +18,7 @@ static int uverbs_free_srq(struct ib_uobject *uobject,
        int ret;
 
        ret = ib_destroy_srq_user(srq, &attrs->driver_udata);
-       if (ib_is_destroy_retryable(ret, why, uobject))
+       if (ret)
                return ret;
 
        if (srq_type == IB_SRQT_XRC) {
@@ -30,7 +30,7 @@ static int uverbs_free_srq(struct ib_uobject *uobject,
        }
 
        ib_uverbs_release_uevent(uevent);
-       return ret;
+       return 0;
 }
 
 static int UVERBS_HANDLER(UVERBS_METHOD_SRQ_CREATE)(
index f2e6a625724a4b90c005b5fb6e595ee336523f29..7ded8339346f31cba157ccb8fcace629460ab953 100644 (file)
@@ -17,11 +17,11 @@ static int uverbs_free_wq(struct ib_uobject *uobject,
        int ret;
 
        ret = ib_destroy_wq_user(wq, &attrs->driver_udata);
-       if (ib_is_destroy_retryable(ret, why, uobject))
+       if (ret)
                return ret;
 
        ib_uverbs_release_uevent(&uwq->uevent);
-       return ret;
+       return 0;
 }
 
 static int UVERBS_HANDLER(UVERBS_METHOD_WQ_CREATE)(
index 611ce21157dec7b446c16193d43b46b570ed470e..c315dbe0b6bd095972f8f43fde87d3bdb864e6a8 100644 (file)
@@ -1310,7 +1310,7 @@ static int devx_obj_cleanup(struct ib_uobject *uobject,
        else
                ret = mlx5_cmd_exec(obj->ib_dev->mdev, obj->dinbox,
                                    obj->dinlen, out, sizeof(out));
-       if (ib_is_destroy_retryable(ret, why, uobject))
+       if (ret)
                return ret;
 
        devx_event_table = &dev->devx_event_table;
@@ -2181,7 +2181,7 @@ static int devx_umem_cleanup(struct ib_uobject *uobject,
        int err;
 
        err = mlx5_cmd_exec(obj->mdev, obj->dinbox, obj->dinlen, out, sizeof(out));
-       if (ib_is_destroy_retryable(err, why, uobject))
+       if (err)
                return err;
 
        ib_umem_release(obj->umem);
index 492cfe063bcade34b87d963e10b797c74509508c..25da0b05b4e2f032fc10163ecf84121dc8a25583 100644 (file)
@@ -2035,11 +2035,9 @@ static int flow_matcher_cleanup(struct ib_uobject *uobject,
                                struct uverbs_attr_bundle *attrs)
 {
        struct mlx5_ib_flow_matcher *obj = uobject->object;
-       int ret;
 
-       ret = ib_destroy_usecnt(&obj->usecnt, why, uobject);
-       if (ret)
-               return ret;
+       if (atomic_read(&obj->usecnt))
+               return -EBUSY;
 
        kfree(obj);
        return 0;
index 9420827d2421880d71a72e7fac2f0d382068739e..7e330f4a6d33ff72052827f2e062cc67a028da3e 100644 (file)
@@ -1471,6 +1471,8 @@ enum rdma_remove_reason {
        RDMA_REMOVE_DRIVER_REMOVE,
        /* uobj is being cleaned-up before being committed */
        RDMA_REMOVE_ABORT,
+       /* The driver failed to destroy the uobject and is being disconnected */
+       RDMA_REMOVE_DRIVER_FAILURE,
 };
 
 struct ib_rdmacg_object {
@@ -1483,8 +1485,6 @@ struct ib_ucontext {
        struct ib_device       *device;
        struct ib_uverbs_file  *ufile;
 
-       bool cleanup_retryable;
-
        struct ib_rdmacg_object cg_obj;
        /*
         * Implementation details of the RDMA core, don't use in drivers:
@@ -2903,46 +2903,6 @@ static inline bool ib_is_udata_cleared(struct ib_udata *udata,
        return ib_is_buffer_cleared(udata->inbuf + offset, len);
 }
 
-/**
- * ib_is_destroy_retryable - Check whether the uobject destruction
- * is retryable.
- * @ret: The initial destruction return code
- * @why: remove reason
- * @uobj: The uobject that is destroyed
- *
- * This function is a helper function that IB layer and low-level drivers
- * can use to consider whether the destruction of the given uobject is
- * retry-able.
- * It checks the original return code, if it wasn't success the destruction
- * is retryable according to the ucontext state (i.e. cleanup_retryable) and
- * the remove reason. (i.e. why).
- * Must be called with the object locked for destroy.
- */
-static inline bool ib_is_destroy_retryable(int ret, enum rdma_remove_reason why,
-                                          struct ib_uobject *uobj)
-{
-       return ret && (why == RDMA_REMOVE_DESTROY ||
-                      uobj->context->cleanup_retryable);
-}
-
-/**
- * ib_destroy_usecnt - Called during destruction to check the usecnt
- * @usecnt: The usecnt atomic
- * @why: remove reason
- * @uobj: The uobject that is destroyed
- *
- * Non-zero usecnts will block destruction unless destruction was triggered by
- * a ucontext cleanup.
- */
-static inline int ib_destroy_usecnt(atomic_t *usecnt,
-                                   enum rdma_remove_reason why,
-                                   struct ib_uobject *uobj)
-{
-       if (atomic_read(usecnt) && ib_is_destroy_retryable(-EBUSY, why, uobj))
-               return -EBUSY;
-       return 0;
-}
-
 /**
  * ib_modify_qp_is_ok - Check that the supplied attribute mask
  * contains all required attributes and no attributes not allowed for