diff mbox series

[RFC,v5,14/16] RDMA/irdma: Add ABI definitions

Message ID 20200417171251.1533371-15-jeffrey.t.kirsher@intel.com (mailing list archive)
State RFC
Headers show
Series Add Intel Ethernet Protocol Driver for RDMA (irdma) | expand

Commit Message

Kirsher, Jeffrey T April 17, 2020, 5:12 p.m. UTC 
From: Mustafa Ismail <mustafa.ismail@intel.com>

Add ABI definitions for irdma.

Signed-off-by: Mustafa Ismail <mustafa.ismail@intel.com>
Signed-off-by: Shiraz Saleem <shiraz.saleem@intel.com>
---
 include/uapi/rdma/irdma-abi.h | 140 ++++++++++++++++++++++++++++++++++
 1 file changed, 140 insertions(+)
 create mode 100644 include/uapi/rdma/irdma-abi.h

Comments

Leon Romanovsky April 17, 2020, 7:43 p.m. UTC | #1 
On Fri, Apr 17, 2020 at 10:12:49AM -0700, Jeff Kirsher wrote:
> From: Mustafa Ismail <mustafa.ismail@intel.com>
>
> Add ABI definitions for irdma.
>
> Signed-off-by: Mustafa Ismail <mustafa.ismail@intel.com>
> Signed-off-by: Shiraz Saleem <shiraz.saleem@intel.com>
> ---
>  include/uapi/rdma/irdma-abi.h | 140 ++++++++++++++++++++++++++++++++++
>  1 file changed, 140 insertions(+)
>  create mode 100644 include/uapi/rdma/irdma-abi.h
>
> diff --git a/include/uapi/rdma/irdma-abi.h b/include/uapi/rdma/irdma-abi.h
> new file mode 100644
> index 000000000000..2eb253220161
> --- /dev/null
> +++ b/include/uapi/rdma/irdma-abi.h
> @@ -0,0 +1,140 @@
> +/* SPDX-License-Identifier: (GPL-2.0 WITH Linux-syscall-note) OR Linux-OpenIB) */
> +/*
> + * Copyright (c) 2006 - 2019 Intel Corporation.  All rights reserved.
> + * Copyright (c) 2005 Topspin Communications.  All rights reserved.
> + * Copyright (c) 2005 Cisco Systems.  All rights reserved.
> + * Copyright (c) 2005 Open Grid Computing, Inc. All rights reserved.
> + */
> +
> +#ifndef IRDMA_ABI_H
> +#define IRDMA_ABI_H
> +
> +#include <linux/types.h>
> +
> +/* irdma must support legacy GEN_1 i40iw kernel
> + * and user-space whose last ABI ver is 5
> + */
> +#define IRDMA_ABI_VER 6
> +
> +enum irdma_memreg_type {
> +	IW_MEMREG_TYPE_MEM  = 0,
> +	IW_MEMREG_TYPE_QP   = 1,
> +	IW_MEMREG_TYPE_CQ   = 2,
> +	IW_MEMREG_TYPE_RSVD = 3,
> +	IW_MEMREG_TYPE_MW   = 4,
> +};
> +
> +struct irdma_alloc_ucontext_req {
> +	__u32 rsvd32;
> +	__u8 userspace_ver;
> +	__u8 rsvd8[3];
> +};
> +
> +struct i40iw_alloc_ucontext_req {
> +	__u32 rsvd32;
> +	__u8 userspace_ver;
> +	__u8 rsvd8[3];
> +};
> +
> +struct irdma_alloc_ucontext_resp {
> +	__aligned_u64 feature_flags;
> +	__aligned_u64 db_mmap_key;
> +	__u32 max_hw_wq_frags;
> +	__u32 max_hw_read_sges;
> +	__u32 max_hw_inline;
> +	__u32 max_hw_rq_quanta;
> +	__u32 max_hw_wq_quanta;
> +	__u32 min_hw_cq_size;
> +	__u32 max_hw_cq_size;
> +	__u32 rsvd1[7];
> +	__u16 max_hw_sq_chunk;
> +	__u16 rsvd2[11];
> +	__u8 kernel_ver;

Why do you need to copy this kernel_ver from i40iw?
Especially given the fact that i40iw didn't use it too much
 120 static int i40iw_alloc_ucontext(struct ib_ucontext *uctx,
 121                                 struct ib_udata *udata)
 <...>
 140         uresp.kernel_ver = req.userspace_ver;

> +	__u8 hw_rev;
> +	__u8 rsvd3[6];
> +};
> +
> +struct i40iw_alloc_ucontext_resp {
> +	__u32 max_pds;
> +	__u32 max_qps;
> +	__u32 wq_size; /* size of the WQs (SQ+RQ) in the mmaped area */
> +	__u8 kernel_ver;
> +	__u8 rsvd[3];
> +};
> +
> +struct irdma_alloc_pd_resp {
> +	__u32 pd_id;
> +	__u8 rsvd[4];
> +};
> +
> +struct irdma_resize_cq_req {
> +	__aligned_u64 user_cq_buffer;
> +};
> +
> +struct irdma_create_cq_req {
> +	__aligned_u64 user_cq_buf;
> +	__aligned_u64 user_shadow_area;
> +};
> +
> +struct irdma_create_qp_req {
> +	__aligned_u64 user_wqe_bufs;
> +	__aligned_u64 user_compl_ctx;
> +};
> +
> +struct i40iw_create_qp_req {
> +	__aligned_u64 user_wqe_bufs;
> +	__aligned_u64 user_compl_ctx;
> +};
> +
> +struct irdma_mem_reg_req {
> +	__u16 reg_type; /* Memory, QP or CQ */
> +	__u16 cq_pages;
> +	__u16 rq_pages;
> +	__u16 sq_pages;
> +};
> +
> +struct irdma_modify_qp_req {
> +	__u8 sq_flush;
> +	__u8 rq_flush;
> +	__u8 rsvd[6];
> +};
> +
> +struct irdma_create_cq_resp {
> +	__u32 cq_id;
> +	__u32 cq_size;
> +};
> +
> +struct irdma_create_qp_resp {
> +	__u32 qp_id;
> +	__u32 actual_sq_size;
> +	__u32 actual_rq_size;
> +	__u32 irdma_drv_opt;
> +	__u32 qp_caps;
> +	__u16 rsvd1;
> +	__u8 lsmm;
> +	__u8 rsvd2;
> +};
> +
> +struct i40iw_create_qp_resp {
> +	__u32 qp_id;
> +	__u32 actual_sq_size;
> +	__u32 actual_rq_size;
> +	__u32 i40iw_drv_opt;
> +	__u16 push_idx;
> +	__u8 lsmm;
> +	__u8 rsvd;
> +};
> +
> +struct irdma_modify_qp_resp {
> +	__aligned_u64 push_wqe_mmap_key;
> +	__aligned_u64 push_db_mmap_key;
> +	__u16 push_offset;
> +	__u8 push_valid;
> +	__u8 rsvd[5];
> +};
> +
> +struct irdma_create_ah_resp {
> +	__u32 ah_id;
> +	__u8 rsvd[4];
> +};
> +#endif /* IRDMA_ABI_H */
> --
> 2.25.2
>
Shiraz Saleem April 21, 2020, 12:29 a.m. UTC | #2 
> Subject: Re: [RFC PATCH v5 14/16] RDMA/irdma: Add ABI definitions
> 
> On Fri, Apr 17, 2020 at 10:12:49AM -0700, Jeff Kirsher wrote:
> > From: Mustafa Ismail <mustafa.ismail@intel.com>
> >
> > Add ABI definitions for irdma.
> >
> > Signed-off-by: Mustafa Ismail <mustafa.ismail@intel.com>
> > Signed-off-by: Shiraz Saleem <shiraz.saleem@intel.com>
> > ---
> >  include/uapi/rdma/irdma-abi.h | 140
> > ++++++++++++++++++++++++++++++++++
> >  1 file changed, 140 insertions(+)
> >  create mode 100644 include/uapi/rdma/irdma-abi.h
> >
> > diff --git a/include/uapi/rdma/irdma-abi.h
> > b/include/uapi/rdma/irdma-abi.h new file mode 100644 index
> > 000000000000..2eb253220161
> > --- /dev/null
> > +++ b/include/uapi/rdma/irdma-abi.h
> > @@ -0,0 +1,140 @@
> > +/* SPDX-License-Identifier: (GPL-2.0 WITH Linux-syscall-note) OR
> > +Linux-OpenIB) */
> > +/*
> > + * Copyright (c) 2006 - 2019 Intel Corporation.  All rights reserved.
> > + * Copyright (c) 2005 Topspin Communications.  All rights reserved.
> > + * Copyright (c) 2005 Cisco Systems.  All rights reserved.
> > + * Copyright (c) 2005 Open Grid Computing, Inc. All rights reserved.
> > + */
> > +
> > +#ifndef IRDMA_ABI_H
> > +#define IRDMA_ABI_H
> > +
> > +#include <linux/types.h>
> > +
> > +/* irdma must support legacy GEN_1 i40iw kernel
> > + * and user-space whose last ABI ver is 5  */ #define IRDMA_ABI_VER 6
> > +
> > +enum irdma_memreg_type {
> > +	IW_MEMREG_TYPE_MEM  = 0,
> > +	IW_MEMREG_TYPE_QP   = 1,
> > +	IW_MEMREG_TYPE_CQ   = 2,
> > +	IW_MEMREG_TYPE_RSVD = 3,
> > +	IW_MEMREG_TYPE_MW   = 4,
> > +};
> > +
> > +struct irdma_alloc_ucontext_req {
> > +	__u32 rsvd32;
> > +	__u8 userspace_ver;
> > +	__u8 rsvd8[3];
> > +};
> > +
> > +struct i40iw_alloc_ucontext_req {
> > +	__u32 rsvd32;
> > +	__u8 userspace_ver;
> > +	__u8 rsvd8[3];
> > +};
> > +
> > +struct irdma_alloc_ucontext_resp {
> > +	__aligned_u64 feature_flags;
> > +	__aligned_u64 db_mmap_key;
> > +	__u32 max_hw_wq_frags;
> > +	__u32 max_hw_read_sges;
> > +	__u32 max_hw_inline;
> > +	__u32 max_hw_rq_quanta;
> > +	__u32 max_hw_wq_quanta;
> > +	__u32 min_hw_cq_size;
> > +	__u32 max_hw_cq_size;
> > +	__u32 rsvd1[7];
> > +	__u16 max_hw_sq_chunk;
> > +	__u16 rsvd2[11];
> > +	__u8 kernel_ver;
> 
> Why do you need to copy this kernel_ver from i40iw?
> Especially given the fact that i40iw didn't use it too much
>  120 static int i40iw_alloc_ucontext(struct ib_ucontext *uctx,
>  121                                 struct ib_udata *udata)
>  <...>
>  140         uresp.kernel_ver = req.userspace_ver;
> 
Its used to pass the current driver ABI ver. to user-space so that
there is compatibility check in user-space as well.
for example: old i40iw user-space provider wont bind to gen_2 devices
by checking the kernel_ver and finding its incompatible. It will bind with
gen_1 devices though..
Leon Romanovsky April 21, 2020, 7:22 a.m. UTC | #3 
On Tue, Apr 21, 2020 at 12:29:15AM +0000, Saleem, Shiraz wrote:
> > Subject: Re: [RFC PATCH v5 14/16] RDMA/irdma: Add ABI definitions
> >
> > On Fri, Apr 17, 2020 at 10:12:49AM -0700, Jeff Kirsher wrote:
> > > From: Mustafa Ismail <mustafa.ismail@intel.com>
> > >
> > > Add ABI definitions for irdma.
> > >
> > > Signed-off-by: Mustafa Ismail <mustafa.ismail@intel.com>
> > > Signed-off-by: Shiraz Saleem <shiraz.saleem@intel.com>
> > > ---
> > >  include/uapi/rdma/irdma-abi.h | 140
> > > ++++++++++++++++++++++++++++++++++
> > >  1 file changed, 140 insertions(+)
> > >  create mode 100644 include/uapi/rdma/irdma-abi.h
> > >
> > > diff --git a/include/uapi/rdma/irdma-abi.h
> > > b/include/uapi/rdma/irdma-abi.h new file mode 100644 index
> > > 000000000000..2eb253220161
> > > --- /dev/null
> > > +++ b/include/uapi/rdma/irdma-abi.h
> > > @@ -0,0 +1,140 @@
> > > +/* SPDX-License-Identifier: (GPL-2.0 WITH Linux-syscall-note) OR
> > > +Linux-OpenIB) */
> > > +/*
> > > + * Copyright (c) 2006 - 2019 Intel Corporation.  All rights reserved.
> > > + * Copyright (c) 2005 Topspin Communications.  All rights reserved.
> > > + * Copyright (c) 2005 Cisco Systems.  All rights reserved.
> > > + * Copyright (c) 2005 Open Grid Computing, Inc. All rights reserved.
> > > + */
> > > +
> > > +#ifndef IRDMA_ABI_H
> > > +#define IRDMA_ABI_H
> > > +
> > > +#include <linux/types.h>
> > > +
> > > +/* irdma must support legacy GEN_1 i40iw kernel
> > > + * and user-space whose last ABI ver is 5  */ #define IRDMA_ABI_VER 6
> > > +
> > > +enum irdma_memreg_type {
> > > +	IW_MEMREG_TYPE_MEM  = 0,
> > > +	IW_MEMREG_TYPE_QP   = 1,
> > > +	IW_MEMREG_TYPE_CQ   = 2,
> > > +	IW_MEMREG_TYPE_RSVD = 3,
> > > +	IW_MEMREG_TYPE_MW   = 4,
> > > +};
> > > +
> > > +struct irdma_alloc_ucontext_req {
> > > +	__u32 rsvd32;
> > > +	__u8 userspace_ver;
> > > +	__u8 rsvd8[3];
> > > +};
> > > +
> > > +struct i40iw_alloc_ucontext_req {
> > > +	__u32 rsvd32;
> > > +	__u8 userspace_ver;
> > > +	__u8 rsvd8[3];
> > > +};
> > > +
> > > +struct irdma_alloc_ucontext_resp {
> > > +	__aligned_u64 feature_flags;
> > > +	__aligned_u64 db_mmap_key;
> > > +	__u32 max_hw_wq_frags;
> > > +	__u32 max_hw_read_sges;
> > > +	__u32 max_hw_inline;
> > > +	__u32 max_hw_rq_quanta;
> > > +	__u32 max_hw_wq_quanta;
> > > +	__u32 min_hw_cq_size;
> > > +	__u32 max_hw_cq_size;
> > > +	__u32 rsvd1[7];
> > > +	__u16 max_hw_sq_chunk;
> > > +	__u16 rsvd2[11];
> > > +	__u8 kernel_ver;
> >
> > Why do you need to copy this kernel_ver from i40iw?
> > Especially given the fact that i40iw didn't use it too much
> >  120 static int i40iw_alloc_ucontext(struct ib_ucontext *uctx,
> >  121                                 struct ib_udata *udata)
> >  <...>
> >  140         uresp.kernel_ver = req.userspace_ver;
> >
> Its used to pass the current driver ABI ver. to user-space so that
> there is compatibility check in user-space as well.
> for example: old i40iw user-space provider wont bind to gen_2 devices
> by checking the kernel_ver and finding its incompatible. It will bind with
> gen_1 devices though..

I understand that you must keep it in struct i40iw_alloc_ucontext_resp,
but here we are talking about struct irdma_alloc_ucontext_resp. Anyway
the rdma-core should be extended to work with this new struct and you
always return kernel_ver == userspace_ver, which makes impossible to
do any compatibility check.

Plus kernel is expected to be backward compatible.

Thanks

>
diff mbox series

Patch

diff --git a/include/uapi/rdma/irdma-abi.h b/include/uapi/rdma/irdma-abi.h
new file mode 100644
index 000000000000..2eb253220161
--- /dev/null
+++ b/include/uapi/rdma/irdma-abi.h
@@ -0,0 +1,140 @@ 
+/* SPDX-License-Identifier: (GPL-2.0 WITH Linux-syscall-note) OR Linux-OpenIB) */
+/*
+ * Copyright (c) 2006 - 2019 Intel Corporation.  All rights reserved.
+ * Copyright (c) 2005 Topspin Communications.  All rights reserved.
+ * Copyright (c) 2005 Cisco Systems.  All rights reserved.
+ * Copyright (c) 2005 Open Grid Computing, Inc. All rights reserved.
+ */
+
+#ifndef IRDMA_ABI_H
+#define IRDMA_ABI_H
+
+#include <linux/types.h>
+
+/* irdma must support legacy GEN_1 i40iw kernel
+ * and user-space whose last ABI ver is 5
+ */
+#define IRDMA_ABI_VER 6
+
+enum irdma_memreg_type {
+	IW_MEMREG_TYPE_MEM  = 0,
+	IW_MEMREG_TYPE_QP   = 1,
+	IW_MEMREG_TYPE_CQ   = 2,
+	IW_MEMREG_TYPE_RSVD = 3,
+	IW_MEMREG_TYPE_MW   = 4,
+};
+
+struct irdma_alloc_ucontext_req {
+	__u32 rsvd32;
+	__u8 userspace_ver;
+	__u8 rsvd8[3];
+};
+
+struct i40iw_alloc_ucontext_req {
+	__u32 rsvd32;
+	__u8 userspace_ver;
+	__u8 rsvd8[3];
+};
+
+struct irdma_alloc_ucontext_resp {
+	__aligned_u64 feature_flags;
+	__aligned_u64 db_mmap_key;
+	__u32 max_hw_wq_frags;
+	__u32 max_hw_read_sges;
+	__u32 max_hw_inline;
+	__u32 max_hw_rq_quanta;
+	__u32 max_hw_wq_quanta;
+	__u32 min_hw_cq_size;
+	__u32 max_hw_cq_size;
+	__u32 rsvd1[7];
+	__u16 max_hw_sq_chunk;
+	__u16 rsvd2[11];
+	__u8 kernel_ver;
+	__u8 hw_rev;
+	__u8 rsvd3[6];
+};
+
+struct i40iw_alloc_ucontext_resp {
+	__u32 max_pds;
+	__u32 max_qps;
+	__u32 wq_size; /* size of the WQs (SQ+RQ) in the mmaped area */
+	__u8 kernel_ver;
+	__u8 rsvd[3];
+};
+
+struct irdma_alloc_pd_resp {
+	__u32 pd_id;
+	__u8 rsvd[4];
+};
+
+struct irdma_resize_cq_req {
+	__aligned_u64 user_cq_buffer;
+};
+
+struct irdma_create_cq_req {
+	__aligned_u64 user_cq_buf;
+	__aligned_u64 user_shadow_area;
+};
+
+struct irdma_create_qp_req {
+	__aligned_u64 user_wqe_bufs;
+	__aligned_u64 user_compl_ctx;
+};
+
+struct i40iw_create_qp_req {
+	__aligned_u64 user_wqe_bufs;
+	__aligned_u64 user_compl_ctx;
+};
+
+struct irdma_mem_reg_req {
+	__u16 reg_type; /* Memory, QP or CQ */
+	__u16 cq_pages;
+	__u16 rq_pages;
+	__u16 sq_pages;
+};
+
+struct irdma_modify_qp_req {
+	__u8 sq_flush;
+	__u8 rq_flush;
+	__u8 rsvd[6];
+};
+
+struct irdma_create_cq_resp {
+	__u32 cq_id;
+	__u32 cq_size;
+};
+
+struct irdma_create_qp_resp {
+	__u32 qp_id;
+	__u32 actual_sq_size;
+	__u32 actual_rq_size;
+	__u32 irdma_drv_opt;
+	__u32 qp_caps;
+	__u16 rsvd1;
+	__u8 lsmm;
+	__u8 rsvd2;
+};
+
+struct i40iw_create_qp_resp {
+	__u32 qp_id;
+	__u32 actual_sq_size;
+	__u32 actual_rq_size;
+	__u32 i40iw_drv_opt;
+	__u16 push_idx;
+	__u8 lsmm;
+	__u8 rsvd;
+};
+
+struct irdma_modify_qp_resp {
+	__aligned_u64 push_wqe_mmap_key;
+	__aligned_u64 push_db_mmap_key;
+	__u16 push_offset;
+	__u8 push_valid;
+	__u8 rsvd[5];
+};
+
+struct irdma_create_ah_resp {
+	__u32 ah_id;
+	__u8 rsvd[4];
+};
+#endif /* IRDMA_ABI_H */