IB: common handling for marshalling parameters to/from userspace

Provide common handling for marshalling data between userspace clients
and kernel InfiniBand drivers.

Signed-off-by: Sean Hefty <sean.hefty@intel.com>
Signed-off-by: Roland Dreier <rolandd@cisco.com>

3 files changed, 154 insertions, 118 deletions

diff --git a/drivers/infiniband/core/Makefile b/drivers/infiniband/core/Makefile
index ec3353f24b27..a56bf9c994f6 100644
--- a/drivers/infiniband/core/Makefile
+++ b/drivers/infiniband/core/Makefile
@@ -16,4 +16,5 @@ ib_umad-y :=			user_mad.o
 
 ib_ucm-y :=                     ucm.o
 
-ib_uverbs-y :=                  uverbs_main.o uverbs_cmd.o uverbs_mem.o
+ib_uverbs-y :=                  uverbs_main.o uverbs_cmd.o uverbs_mem.o \
+                                uverbs_marshall.o
diff --git a/drivers/infiniband/core/ucm.c b/drivers/infiniband/core/ucm.c
index 9164a09b6ccd..b396bf703f80 100644
--- a/drivers/infiniband/core/ucm.c
+++ b/drivers/infiniband/core/ucm.c
@@ -30,7 +30,7 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  *
- * $Id: ucm.c 2594 2005-06-13 19:46:02Z libor $
+ * $Id: ucm.c 4311 2005-12-05 18:42:01Z sean.hefty $
  */
 
 #include <linux/completion.h>
@@ -50,6 +50,7 @@
 
 #include <rdma/ib_cm.h>
 #include <rdma/ib_user_cm.h>
+#include <rdma/ib_marshall.h>
 
 MODULE_AUTHOR("Libor Michalek");
 MODULE_DESCRIPTION("InfiniBand userspace Connection Manager access");
@@ -205,36 +206,6 @@ error:
         return NULL;
 }
 
-static void ib_ucm_event_path_get(struct ib_ucm_path_rec *upath,
-                                  struct ib_sa_path_rec  *kpath)
-{
-        if (!kpath || !upath)
-                return;
-
-        memcpy(upath->dgid, kpath->dgid.raw, sizeof *upath->dgid);
-        memcpy(upath->sgid, kpath->sgid.raw, sizeof *upath->sgid);
-
-        upath->dlid             = kpath->dlid;
-        upath->slid             = kpath->slid;
-        upath->raw_traffic      = kpath->raw_traffic;
-        upath->flow_label       = kpath->flow_label;
-        upath->hop_limit        = kpath->hop_limit;
-        upath->traffic_class    = kpath->traffic_class;
-        upath->reversible       = kpath->reversible;
-        upath->numb_path        = kpath->numb_path;
-        upath->pkey             = kpath->pkey;
-        upath->sl               = kpath->sl;
-        upath->mtu_selector     = kpath->mtu_selector;
-        upath->mtu              = kpath->mtu;
-        upath->rate_selector    = kpath->rate_selector;
-        upath->rate             = kpath->rate;
-        upath->packet_life_time = kpath->packet_life_time;
-        upath->preference       = kpath->preference;
-
-        upath->packet_life_time_selector =
-                kpath->packet_life_time_selector;
-}
-
 static void ib_ucm_event_req_get(struct ib_ucm_req_event_resp *ureq,
                                  struct ib_cm_req_event_param *kreq)
 {
@@ -253,8 +224,10 @@ static void ib_ucm_event_req_get(struct ib_ucm_req_event_resp *ureq,
         ureq->srq                        = kreq->srq;
         ureq->port                       = kreq->port;
 
-        ib_ucm_event_path_get(&ureq->primary_path, kreq->primary_path);
-        ib_ucm_event_path_get(&ureq->alternate_path, kreq->alternate_path);
+        ib_copy_path_rec_to_user(&ureq->primary_path, kreq->primary_path);
+        if (kreq->alternate_path)
+                ib_copy_path_rec_to_user(&ureq->alternate_path,
+                                         kreq->alternate_path);
 }
 
 static void ib_ucm_event_rep_get(struct ib_ucm_rep_event_resp *urep,
@@ -324,8 +297,8 @@ static int ib_ucm_event_process(struct ib_cm_event *evt,
                 info          = evt->param.rej_rcvd.ari;
                 break;
         case IB_CM_LAP_RECEIVED:
-                ib_ucm_event_path_get(&uvt->resp.u.lap_resp.path,
-                                      evt->param.lap_rcvd.alternate_path);
+                ib_copy_path_rec_to_user(&uvt->resp.u.lap_resp.path,
+                                         evt->param.lap_rcvd.alternate_path);
                 uvt->data_len = IB_CM_LAP_PRIVATE_DATA_SIZE;
                 uvt->resp.present = IB_UCM_PRES_ALTERNATE;
                 break;
@@ -637,65 +610,11 @@ static ssize_t ib_ucm_attr_id(struct ib_ucm_file *file,
         return result;
 }
 
-static void ib_ucm_copy_ah_attr(struct ib_ucm_ah_attr *dest_attr,
-                                struct ib_ah_attr *src_attr)
-{
-        memcpy(dest_attr->grh_dgid, src_attr->grh.dgid.raw,
-               sizeof src_attr->grh.dgid);
-        dest_attr->grh_flow_label = src_attr->grh.flow_label;
-        dest_attr->grh_sgid_index = src_attr->grh.sgid_index;
-        dest_attr->grh_hop_limit = src_attr->grh.hop_limit;
-        dest_attr->grh_traffic_class = src_attr->grh.traffic_class;
-
-        dest_attr->dlid = src_attr->dlid;
-        dest_attr->sl = src_attr->sl;
-        dest_attr->src_path_bits = src_attr->src_path_bits;
-        dest_attr->static_rate = src_attr->static_rate;
-        dest_attr->is_global = (src_attr->ah_flags & IB_AH_GRH);
-        dest_attr->port_num = src_attr->port_num;
-}
-
-static void ib_ucm_copy_qp_attr(struct ib_ucm_init_qp_attr_resp *dest_attr,
-                                struct ib_qp_attr *src_attr)
-{
-        dest_attr->cur_qp_state = src_attr->cur_qp_state;
-        dest_attr->path_mtu = src_attr->path_mtu;
-        dest_attr->path_mig_state = src_attr->path_mig_state;
-        dest_attr->qkey = src_attr->qkey;
-        dest_attr->rq_psn = src_attr->rq_psn;
-        dest_attr->sq_psn = src_attr->sq_psn;
-        dest_attr->dest_qp_num = src_attr->dest_qp_num;
-        dest_attr->qp_access_flags = src_attr->qp_access_flags;
-
-        dest_attr->max_send_wr = src_attr->cap.max_send_wr;
-        dest_attr->max_recv_wr = src_attr->cap.max_recv_wr;
-        dest_attr->max_send_sge = src_attr->cap.max_send_sge;
-        dest_attr->max_recv_sge = src_attr->cap.max_recv_sge;
-        dest_attr->max_inline_data = src_attr->cap.max_inline_data;
-
-        ib_ucm_copy_ah_attr(&dest_attr->ah_attr, &src_attr->ah_attr);
-        ib_ucm_copy_ah_attr(&dest_attr->alt_ah_attr, &src_attr->alt_ah_attr);
-
-        dest_attr->pkey_index = src_attr->pkey_index;
-        dest_attr->alt_pkey_index = src_attr->alt_pkey_index;
-        dest_attr->en_sqd_async_notify = src_attr->en_sqd_async_notify;
-        dest_attr->sq_draining = src_attr->sq_draining;
-        dest_attr->max_rd_atomic = src_attr->max_rd_atomic;
-        dest_attr->max_dest_rd_atomic = src_attr->max_dest_rd_atomic;
-        dest_attr->min_rnr_timer = src_attr->min_rnr_timer;
-        dest_attr->port_num = src_attr->port_num;
-        dest_attr->timeout = src_attr->timeout;
-        dest_attr->retry_cnt = src_attr->retry_cnt;
-        dest_attr->rnr_retry = src_attr->rnr_retry;
-        dest_attr->alt_port_num = src_attr->alt_port_num;
-        dest_attr->alt_timeout = src_attr->alt_timeout;
-}
-
 static ssize_t ib_ucm_init_qp_attr(struct ib_ucm_file *file,
                                    const char __user *inbuf,
                                    int in_len, int out_len)
 {
-        struct ib_ucm_init_qp_attr_resp resp;
+        struct ib_uverbs_qp_attr resp;
         struct ib_ucm_init_qp_attr cmd;
         struct ib_ucm_context *ctx;
         struct ib_qp_attr qp_attr;
@@ -718,7 +637,7 @@ static ssize_t ib_ucm_init_qp_attr(struct ib_ucm_file *file,
         if (result)
                 goto out;
 
-        ib_ucm_copy_qp_attr(&resp, &qp_attr);
+        ib_copy_qp_attr_to_user(&resp, &qp_attr);
 
         if (copy_to_user((void __user *)(unsigned long)cmd.response,
                          &resp, sizeof(resp)))
@@ -793,7 +712,7 @@ static int ib_ucm_alloc_data(const void **dest, u64 src, u32 len)
 
 static int ib_ucm_path_get(struct ib_sa_path_rec **path, u64 src)
 {
-        struct ib_ucm_path_rec ucm_path;
+        struct ib_user_path_rec upath;
         struct ib_sa_path_rec  *sa_path;
 
         *path = NULL;
@@ -805,36 +724,14 @@ static int ib_ucm_path_get(struct ib_sa_path_rec **path, u64 src)
         if (!sa_path)
                 return -ENOMEM;
 
-        if (copy_from_user(&ucm_path, (void __user *)(unsigned long)src,
-                           sizeof(ucm_path))) {
+        if (copy_from_user(&upath, (void __user *)(unsigned long)src,
+                           sizeof(upath))) {
 
                 kfree(sa_path);
                 return -EFAULT;
         }
 
-        memcpy(sa_path->dgid.raw, ucm_path.dgid, sizeof sa_path->dgid);
-        memcpy(sa_path->sgid.raw, ucm_path.sgid, sizeof sa_path->sgid);
-
-        sa_path->dlid             = ucm_path.dlid;
-        sa_path->slid             = ucm_path.slid;
-        sa_path->raw_traffic      = ucm_path.raw_traffic;
-        sa_path->flow_label       = ucm_path.flow_label;
-        sa_path->hop_limit        = ucm_path.hop_limit;
-        sa_path->traffic_class    = ucm_path.traffic_class;
-        sa_path->reversible       = ucm_path.reversible;
-        sa_path->numb_path        = ucm_path.numb_path;
-        sa_path->pkey             = ucm_path.pkey;
-        sa_path->sl               = ucm_path.sl;
-        sa_path->mtu_selector     = ucm_path.mtu_selector;
-        sa_path->mtu              = ucm_path.mtu;
-        sa_path->rate_selector    = ucm_path.rate_selector;
-        sa_path->rate             = ucm_path.rate;
-        sa_path->packet_life_time = ucm_path.packet_life_time;
-        sa_path->preference       = ucm_path.preference;
-
-        sa_path->packet_life_time_selector =
-                ucm_path.packet_life_time_selector;
-
+        ib_copy_path_rec_from_user(sa_path, &upath);
         *path = sa_path;
         return 0;
 }
diff --git a/drivers/infiniband/core/uverbs_marshall.c b/drivers/infiniband/core/uverbs_marshall.c
new file mode 100644
index 000000000000..ce46b13ae02b
--- /dev/null
+++ b/drivers/infiniband/core/uverbs_marshall.c
@@ -0,0 +1,138 @@
+/*
+ * Copyright (c) 2005 Intel Corporation.  All rights reserved.
+ *
+ * This software is available to you under a choice of one of two
+ * licenses.  You may choose to be licensed under the terms of the GNU
+ * General Public License (GPL) Version 2, available from the file
+ * COPYING in the main directory of this source tree, or the
+ * OpenIB.org BSD license below:
+ *
+ *     Redistribution and use in source and binary forms, with or
+ *     without modification, are permitted provided that the following
+ *     conditions are met:
+ *
+ *      - Redistributions of source code must retain the above
+ *        copyright notice, this list of conditions and the following
+ *        disclaimer.
+ *
+ *      - Redistributions in binary form must reproduce the above
+ *        copyright notice, this list of conditions and the following
+ *        disclaimer in the documentation and/or other materials
+ *        provided with the distribution.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+ * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#include <rdma/ib_marshall.h>
+
+static void ib_copy_ah_attr_to_user(struct ib_uverbs_ah_attr *dst,
+                                    struct ib_ah_attr *src)
+{
+        memcpy(dst->grh.dgid, src->grh.dgid.raw, sizeof src->grh.dgid);
+        dst->grh.flow_label        = src->grh.flow_label;
+        dst->grh.sgid_index        = src->grh.sgid_index;
+        dst->grh.hop_limit         = src->grh.hop_limit;
+        dst->grh.traffic_class     = src->grh.traffic_class;
+        dst->dlid                  = src->dlid;
+        dst->sl                    = src->sl;
+        dst->src_path_bits         = src->src_path_bits;
+        dst->static_rate           = src->static_rate;
+        dst->is_global             = src->ah_flags & IB_AH_GRH ? 1 : 0;
+        dst->port_num              = src->port_num;
+}
+
+void ib_copy_qp_attr_to_user(struct ib_uverbs_qp_attr *dst,
+                             struct ib_qp_attr *src)
+{
+        dst->cur_qp_state       = src->cur_qp_state;
+        dst->path_mtu           = src->path_mtu;
+        dst->path_mig_state     = src->path_mig_state;
+        dst->qkey               = src->qkey;
+        dst->rq_psn             = src->rq_psn;
+        dst->sq_psn             = src->sq_psn;
+        dst->dest_qp_num        = src->dest_qp_num;
+        dst->qp_access_flags    = src->qp_access_flags;
+
+        dst->max_send_wr        = src->cap.max_send_wr;
+        dst->max_recv_wr        = src->cap.max_recv_wr;
+        dst->max_send_sge       = src->cap.max_send_sge;
+        dst->max_recv_sge       = src->cap.max_recv_sge;
+        dst->max_inline_data    = src->cap.max_inline_data;
+
+        ib_copy_ah_attr_to_user(&dst->ah_attr, &src->ah_attr);
+        ib_copy_ah_attr_to_user(&dst->alt_ah_attr, &src->alt_ah_attr);
+
+        dst->pkey_index         = src->pkey_index;
+        dst->alt_pkey_index     = src->alt_pkey_index;
+        dst->en_sqd_async_notify = src->en_sqd_async_notify;
+        dst->sq_draining        = src->sq_draining;
+        dst->max_rd_atomic      = src->max_rd_atomic;
+        dst->max_dest_rd_atomic = src->max_dest_rd_atomic;
+        dst->min_rnr_timer      = src->min_rnr_timer;
+        dst->port_num           = src->port_num;
+        dst->timeout            = src->timeout;
+        dst->retry_cnt          = src->retry_cnt;
+        dst->rnr_retry          = src->rnr_retry;
+        dst->alt_port_num       = src->alt_port_num;
+        dst->alt_timeout        = src->alt_timeout;
+}
+EXPORT_SYMBOL(ib_copy_qp_attr_to_user);
+
+void ib_copy_path_rec_to_user(struct ib_user_path_rec *dst,
+                              struct ib_sa_path_rec *src)
+{
+        memcpy(dst->dgid, src->dgid.raw, sizeof src->dgid);
+        memcpy(dst->sgid, src->sgid.raw, sizeof src->sgid);
+
+        dst->dlid               = src->dlid;
+        dst->slid               = src->slid;
+        dst->raw_traffic        = src->raw_traffic;
+        dst->flow_label         = src->flow_label;
+        dst->hop_limit          = src->hop_limit;
+        dst->traffic_class      = src->traffic_class;
+        dst->reversible         = src->reversible;
+        dst->numb_path          = src->numb_path;
+        dst->pkey               = src->pkey;
+        dst->sl                 = src->sl;
+        dst->mtu_selector       = src->mtu_selector;
+        dst->mtu                = src->mtu;
+        dst->rate_selector      = src->rate_selector;
+        dst->rate               = src->rate;
+        dst->packet_life_time   = src->packet_life_time;
+        dst->preference         = src->preference;
+        dst->packet_life_time_selector = src->packet_life_time_selector;
+}
+EXPORT_SYMBOL(ib_copy_path_rec_to_user);
+
+void ib_copy_path_rec_from_user(struct ib_sa_path_rec *dst,
+                                struct ib_user_path_rec *src)
+{
+        memcpy(dst->dgid.raw, src->dgid, sizeof dst->dgid);
+        memcpy(dst->sgid.raw, src->sgid, sizeof dst->sgid);
+
+        dst->dlid               = src->dlid;
+        dst->slid               = src->slid;
+        dst->raw_traffic        = src->raw_traffic;
+        dst->flow_label         = src->flow_label;
+        dst->hop_limit          = src->hop_limit;
+        dst->traffic_class      = src->traffic_class;
+        dst->reversible         = src->reversible;
+        dst->numb_path          = src->numb_path;
+        dst->pkey               = src->pkey;
+        dst->sl                 = src->sl;
+        dst->mtu_selector       = src->mtu_selector;
+        dst->mtu                = src->mtu;
+        dst->rate_selector      = src->rate_selector;
+        dst->rate               = src->rate;
+        dst->packet_life_time   = src->packet_life_time;
+        dst->preference         = src->preference;
+        dst->packet_life_time_selector = src->packet_life_time_selector;
+}
+EXPORT_SYMBOL(ib_copy_path_rec_from_user);