IB/core: Add completion queue (cq) object actions
authorMatan Barak <matanb@mellanox.com>
Thu, 3 Aug 2017 13:07:05 +0000 (16:07 +0300)
committerDoug Ledford <dledford@redhat.com>
Thu, 31 Aug 2017 12:35:13 +0000 (08:35 -0400)
Adding CQ ioctl actions:
1. create_cq
2. destroy_cq

This requires adding the following:
1. A specification describing the method
a. Handler
b. Attributes specification
Each attribute is one of the following:
a. PTR_IN - input data
    Note: This could be encoded inlined for
  data < 64bit
b. PTR_OUT - response data
c. IDR - idr based object
d. FD - fd based object
                Blobs attributes (clauses a and b) contain their type,
        while objects specifications (clauses c and d)
                contains the expected object type (for example, the
                given id should be UVERBS_TYPE_PD) and the required
                access (READ, WRITE, NEW or DESTROY). If a NEW is
                required, the new object's id will be assigned to this
                attribute. All attributes could get UA_FLAGS
                attribute. Currently we support stating that an
attribute is mandatory or that the specification size
                corresponds to a lower bound (and that this attribute
could be extended).
We currently add both default attributes and the two
generic UHW_IN and UHW_OUT driver specific attributes.
2. Handler
   A handler gets a uverbs_attr_bundle. The handler developer uses
   uverbs_attr_get to fetch an attribute of a given id.
   Each of these attribute groups correspond to the specification
   group defined in the action (clauses 1.b and 1.c respectively).
   The indices of these arrays corresponds to the attribute ids
   declared in the specifications (clause 2).

   The handler is quite simple. It assumes the infrastructure fetched
   all objects and locked, created or destroyed them as required by
   the specification. Pointer (or blob) attributes were validated to
   match their required sizes. After the handler finished, the
   infrastructure commits or rollbacks the objects.

Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
drivers/infiniband/core/uverbs_std_types.c
include/uapi/rdma/ib_user_ioctl_verbs.h

index db66c18..0a98579 100644 (file)
@@ -249,6 +249,140 @@ static void create_udata(struct uverbs_attr_bundle *ctx,
        INIT_UDATA_BUF_OR_NULL(udata, inbuf, outbuf, inbuf_len, outbuf_len);
 }
 
+static int uverbs_create_cq_handler(struct ib_device *ib_dev,
+                                   struct ib_uverbs_file *file,
+                                   struct uverbs_attr_bundle *attrs)
+{
+       struct ib_ucontext *ucontext = file->ucontext;
+       struct ib_ucq_object           *obj;
+       struct ib_udata uhw;
+       int ret;
+       u64 user_handle;
+       struct ib_cq_init_attr attr = {};
+       struct ib_cq                   *cq;
+       struct ib_uverbs_completion_event_file    *ev_file = NULL;
+       const struct uverbs_attr *ev_file_attr;
+       struct ib_uobject *ev_file_uobj;
+
+       if (!(ib_dev->uverbs_cmd_mask & 1ULL << IB_USER_VERBS_CMD_CREATE_CQ))
+               return -EOPNOTSUPP;
+
+       ret = uverbs_copy_from(&attr.comp_vector, attrs, CREATE_CQ_COMP_VECTOR);
+       if (!ret)
+               ret = uverbs_copy_from(&attr.cqe, attrs, CREATE_CQ_CQE);
+       if (!ret)
+               ret = uverbs_copy_from(&user_handle, attrs, CREATE_CQ_USER_HANDLE);
+       if (ret)
+               return ret;
+
+       /* Optional param, if it doesn't exist, we get -ENOENT and skip it */
+       if (uverbs_copy_from(&attr.flags, attrs, CREATE_CQ_FLAGS) == -EFAULT)
+               return -EFAULT;
+
+       ev_file_attr = uverbs_attr_get(attrs, CREATE_CQ_COMP_CHANNEL);
+       if (!IS_ERR(ev_file_attr)) {
+               ev_file_uobj = ev_file_attr->obj_attr.uobject;
+
+               ev_file = container_of(ev_file_uobj,
+                                      struct ib_uverbs_completion_event_file,
+                                      uobj_file.uobj);
+               uverbs_uobject_get(ev_file_uobj);
+       }
+
+       if (attr.comp_vector >= ucontext->ufile->device->num_comp_vectors) {
+               ret = -EINVAL;
+               goto err_event_file;
+       }
+
+       obj = container_of(uverbs_attr_get(attrs, CREATE_CQ_HANDLE)->obj_attr.uobject,
+                          typeof(*obj), uobject);
+       obj->uverbs_file           = ucontext->ufile;
+       obj->comp_events_reported  = 0;
+       obj->async_events_reported = 0;
+       INIT_LIST_HEAD(&obj->comp_list);
+       INIT_LIST_HEAD(&obj->async_list);
+
+       /* Temporary, only until drivers get the new uverbs_attr_bundle */
+       create_udata(attrs, &uhw);
+
+       cq = ib_dev->create_cq(ib_dev, &attr, ucontext, &uhw);
+       if (IS_ERR(cq)) {
+               ret = PTR_ERR(cq);
+               goto err_event_file;
+       }
+
+       cq->device        = ib_dev;
+       cq->uobject       = &obj->uobject;
+       cq->comp_handler  = ib_uverbs_comp_handler;
+       cq->event_handler = ib_uverbs_cq_event_handler;
+       cq->cq_context    = &ev_file->ev_queue;
+       obj->uobject.object = cq;
+       obj->uobject.user_handle = user_handle;
+       atomic_set(&cq->usecnt, 0);
+
+       ret = uverbs_copy_to(attrs, CREATE_CQ_RESP_CQE, &cq->cqe);
+       if (ret)
+               goto err_cq;
+
+       return 0;
+err_cq:
+       ib_destroy_cq(cq);
+
+err_event_file:
+       if (ev_file)
+               uverbs_uobject_put(ev_file_uobj);
+       return ret;
+};
+
+static DECLARE_UVERBS_METHOD(
+       uverbs_method_cq_create, UVERBS_CQ_CREATE, uverbs_create_cq_handler,
+       &UVERBS_ATTR_IDR(CREATE_CQ_HANDLE, UVERBS_OBJECT_CQ, UVERBS_ACCESS_NEW,
+                        UA_FLAGS(UVERBS_ATTR_SPEC_F_MANDATORY)),
+       &UVERBS_ATTR_PTR_IN(CREATE_CQ_CQE, u32,
+                           UA_FLAGS(UVERBS_ATTR_SPEC_F_MANDATORY)),
+       &UVERBS_ATTR_PTR_IN(CREATE_CQ_USER_HANDLE, u64,
+                           UA_FLAGS(UVERBS_ATTR_SPEC_F_MANDATORY)),
+       &UVERBS_ATTR_FD(CREATE_CQ_COMP_CHANNEL, UVERBS_OBJECT_COMP_CHANNEL,
+                       UVERBS_ACCESS_READ),
+       &UVERBS_ATTR_PTR_IN(CREATE_CQ_COMP_VECTOR, u32,
+                           UA_FLAGS(UVERBS_ATTR_SPEC_F_MANDATORY)),
+       &UVERBS_ATTR_PTR_IN(CREATE_CQ_FLAGS, u32),
+       &UVERBS_ATTR_PTR_OUT(CREATE_CQ_RESP_CQE, u32,
+                            UA_FLAGS(UVERBS_ATTR_SPEC_F_MANDATORY)),
+       &uverbs_uhw_compat_in, &uverbs_uhw_compat_out);
+
+static int uverbs_destroy_cq_handler(struct ib_device *ib_dev,
+                                    struct ib_uverbs_file *file,
+                                    struct uverbs_attr_bundle *attrs)
+{
+       struct ib_uverbs_destroy_cq_resp resp;
+       struct ib_uobject *uobj =
+               uverbs_attr_get(attrs, DESTROY_CQ_HANDLE)->obj_attr.uobject;
+       struct ib_ucq_object *obj = container_of(uobj, struct ib_ucq_object,
+                                                uobject);
+       int ret;
+
+       if (!(ib_dev->uverbs_cmd_mask & 1ULL << IB_USER_VERBS_CMD_DESTROY_CQ))
+               return -EOPNOTSUPP;
+
+       ret = rdma_explicit_destroy(uobj);
+       if (ret)
+               return ret;
+
+       resp.comp_events_reported  = obj->comp_events_reported;
+       resp.async_events_reported = obj->async_events_reported;
+
+       return uverbs_copy_to(attrs, DESTROY_CQ_RESP, &resp);
+}
+
+static DECLARE_UVERBS_METHOD(
+       uverbs_method_cq_destroy, UVERBS_CQ_DESTROY, uverbs_destroy_cq_handler,
+       &UVERBS_ATTR_IDR(DESTROY_CQ_HANDLE, UVERBS_OBJECT_CQ,
+                        UVERBS_ACCESS_DESTROY,
+                        UA_FLAGS(UVERBS_ATTR_SPEC_F_MANDATORY)),
+       &UVERBS_ATTR_PTR_OUT(DESTROY_CQ_RESP, struct ib_uverbs_destroy_cq_resp,
+                            UA_FLAGS(UVERBS_ATTR_SPEC_F_MANDATORY)));
+
 DECLARE_UVERBS_OBJECT(uverbs_object_comp_channel,
                      UVERBS_OBJECT_COMP_CHANNEL,
                      &UVERBS_TYPE_ALLOC_FD(0,
@@ -259,7 +393,9 @@ DECLARE_UVERBS_OBJECT(uverbs_object_comp_channel,
 
 DECLARE_UVERBS_OBJECT(uverbs_object_cq, UVERBS_OBJECT_CQ,
                      &UVERBS_TYPE_ALLOC_IDR_SZ(sizeof(struct ib_ucq_object), 0,
-                                                 uverbs_free_cq));
+                                                 uverbs_free_cq),
+                     &uverbs_method_cq_create,
+                     &uverbs_method_cq_destroy);
 
 DECLARE_UVERBS_OBJECT(uverbs_object_qp, UVERBS_OBJECT_QP,
                      &UVERBS_TYPE_ALLOC_IDR_SZ(sizeof(struct ib_uqp_object), 0,
index 90f81ee..842792e 100644 (file)
@@ -60,5 +60,25 @@ enum {
        UVERBS_UHW_OUT,
 };
 
+enum uverbs_create_cq_cmd_attr_ids {
+       CREATE_CQ_HANDLE,
+       CREATE_CQ_CQE,
+       CREATE_CQ_USER_HANDLE,
+       CREATE_CQ_COMP_CHANNEL,
+       CREATE_CQ_COMP_VECTOR,
+       CREATE_CQ_FLAGS,
+       CREATE_CQ_RESP_CQE,
+};
+
+enum uverbs_destroy_cq_cmd_attr_ids {
+       DESTROY_CQ_HANDLE,
+       DESTROY_CQ_RESP,
+};
+
+enum uverbs_actions_cq_ops {
+       UVERBS_CQ_CREATE,
+       UVERBS_CQ_DESTROY,
+};
+
 #endif