diff mbox

[RFC,ABI,V2,1/8] RDMA/core: Export RDMA IOCTL declarations

Message ID 1468941812-32286-2-git-send-email-matanb@mellanox.com (mailing list archive)
State RFC
Headers show

Commit Message

Matan Barak July 19, 2016, 3:23 p.m. UTC 
From: Leon Romanovsky <leonro@mellanox.com>

Place all external RDMA IOCTL declarations into one UAPI exported
header file and move all legacy MAD commands to that file.

Signed-off-by: Matan Barak <matanb@mellanox.com>
Signed-off-by: Haggai Eran <haggaie@mellanox.com>
Signed-off-by: Leon Romanovsky <leonro@mellanox.com>
---
 drivers/infiniband/core/user_mad.c  |  2 +-
 include/rdma/rdma_ioctl.h           | 38 ++++++++++++++++++++++++
 include/uapi/rdma/Kbuild            |  1 +
 include/uapi/rdma/ib_user_mad.h     | 12 --------
 include/uapi/rdma/rdma_user_ioctl.h | 59 +++++++++++++++++++++++++++++++++++++
 5 files changed, 99 insertions(+), 13 deletions(-)
 create mode 100644 include/rdma/rdma_ioctl.h
 create mode 100644 include/uapi/rdma/rdma_user_ioctl.h

Comments

Christoph Lameter (Ampere) July 20, 2016, 1:06 a.m. UTC | #1 
On Tue, 19 Jul 2016, Matan Barak wrote:

> Place all external RDMA IOCTL declarations into one UAPI exported
> header file and move all legacy MAD commands to that file.

Reviewed-by: Christoph Lameter <cl@linux.com>

Isnt this actually a proper cleanup because the legacy ioctl
definitions for MAD commands should have been a part of the uapi?
Thus this patch could be merged immediately?
--
To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Leon Romanovsky July 20, 2016, 3:15 a.m. UTC | #2 
On Tue, Jul 19, 2016 at 08:06:35PM -0500, Christoph Lameter wrote:
> On Tue, 19 Jul 2016, Matan Barak wrote:
> 
> > Place all external RDMA IOCTL declarations into one UAPI exported
> > header file and move all legacy MAD commands to that file.
> 
> Reviewed-by: Christoph Lameter <cl@linux.com>
> 
> Isnt this actually a proper cleanup because the legacy ioctl
> definitions for MAD commands should have been a part of the uapi?
> Thus this patch could be merged immediately?

Yes, it will.
We will respin this patch along with IDR refactoring patch as a separate
patchset to RFC ABI patches.

Thanks.

> --
> To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
Christoph Hellwig July 21, 2016, 8:07 a.m. UTC | #3 
On Tue, Jul 19, 2016 at 06:23:25PM +0300, Matan Barak wrote:
> From: Leon Romanovsky <leonro@mellanox.com>
> 
> Place all external RDMA IOCTL declarations into one UAPI exported
> header file and move all legacy MAD commands to that file.

FYI, we also need to have all the structures used for the UAPI in
a uapi header.  I started on that a while ago, but it needs to be
resurrected.  Given that you're busy in this area it might be a good
idea if you pick this work up:

http://git.infradead.org/users/hch/rdma.git/shortlog/refs/heads/rdma-uapi

> +#ifndef RDMA_IOCTL_H
> +#define RDMA_IOCTL_H
> +
> +#include <rdma/rdma_user_ioctl.h>
> +
> +#endif /* RDMA_IOCTL_H */

What's the point of this wrappers?  Either way no need to include
guards for a no-op header if it will be kept around for some reason.

> +/*
> + * For hfi1 driver
> + */
> +#define IB_IOCTL_MAGIC			RDMA_IOCTL_MAGIC
> +
> +/* Legacy part
> + * !!!! NOTE: It uses the same command index as VERBS
> + */

In that case it should be in the same header just to avoid confusion.
--
To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Leon Romanovsky July 21, 2016, 10:49 a.m. UTC | #4 
On Thu, Jul 21, 2016 at 01:07:19AM -0700, Christoph Hellwig wrote:
> On Tue, Jul 19, 2016 at 06:23:25PM +0300, Matan Barak wrote:
> > From: Leon Romanovsky <leonro@mellanox.com>
> > 
> > Place all external RDMA IOCTL declarations into one UAPI exported
> > header file and move all legacy MAD commands to that file.
> 
> FYI, we also need to have all the structures used for the UAPI in
> a uapi header.  I started on that a while ago, but it needs to be
> resurrected.  Given that you're busy in this area it might be a good
> idea if you pick this work up:
> 
> http://git.infradead.org/users/hch/rdma.git/shortlog/refs/heads/rdma-uapi
> 
> > +#ifndef RDMA_IOCTL_H
> > +#define RDMA_IOCTL_H
> > +
> > +#include <rdma/rdma_user_ioctl.h>
> > +
> > +#endif /* RDMA_IOCTL_H */
> 
> What's the point of this wrappers?  Either way no need to include
> guards for a no-op header if it will be kept around for some reason.

I dropped this file, it is not needed.

> 
> > +/*
> > + * For hfi1 driver
> > + */
> > +#define IB_IOCTL_MAGIC			RDMA_IOCTL_MAGIC
> > +
> > +/* Legacy part
> > + * !!!! NOTE: It uses the same command index as VERBS
> > + */
> 
> In that case it should be in the same header just to avoid confusion.

I prepared proper series for this stuff and will send next week.

Thanks

> --
> To unsubscribe from this list: send the line "unsubscribe linux-rdma" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/drivers/infiniband/core/user_mad.c b/drivers/infiniband/core/user_mad.c
index 415a318..70e974e 100644
--- a/drivers/infiniband/core/user_mad.c
+++ b/drivers/infiniband/core/user_mad.c
@@ -52,8 +52,8 @@ 
 
 #include <asm/uaccess.h>
 
+#include <rdma/rdma_ioctl.h>
 #include <rdma/ib_mad.h>
-#include <rdma/ib_user_mad.h>
 
 MODULE_AUTHOR("Roland Dreier");
 MODULE_DESCRIPTION("InfiniBand userspace MAD packet access");
diff --git a/include/rdma/rdma_ioctl.h b/include/rdma/rdma_ioctl.h
new file mode 100644
index 0000000..f62a359
--- /dev/null
+++ b/include/rdma/rdma_ioctl.h
@@ -0,0 +1,38 @@ 
+/*
+ * Copyright (c) 2016 Mellanox Technologies, LTD. 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.
+ */
+
+#ifndef RDMA_IOCTL_H
+#define RDMA_IOCTL_H
+
+#include <rdma/rdma_user_ioctl.h>
+
+#endif /* RDMA_IOCTL_H */
diff --git a/include/uapi/rdma/Kbuild b/include/uapi/rdma/Kbuild
index 231901b..537e40e 100644
--- a/include/uapi/rdma/Kbuild
+++ b/include/uapi/rdma/Kbuild
@@ -1,5 +1,6 @@ 
 # UAPI Header export list
 header-y += ib_user_cm.h
+header-y += rdma_user_ioctl.h
 header-y += ib_user_mad.h
 header-y += ib_user_sa.h
 header-y += ib_user_verbs.h
diff --git a/include/uapi/rdma/ib_user_mad.h b/include/uapi/rdma/ib_user_mad.h
index 09f809f..7e722e7 100644
--- a/include/uapi/rdma/ib_user_mad.h
+++ b/include/uapi/rdma/ib_user_mad.h
@@ -230,16 +230,4 @@  struct ib_user_mad_reg_req2 {
 	__u8	reserved[3];
 };
 
-#define IB_IOCTL_MAGIC		0x1b
-
-#define IB_USER_MAD_REGISTER_AGENT	_IOWR(IB_IOCTL_MAGIC, 1, \
-					      struct ib_user_mad_reg_req)
-
-#define IB_USER_MAD_UNREGISTER_AGENT	_IOW(IB_IOCTL_MAGIC, 2, __u32)
-
-#define IB_USER_MAD_ENABLE_PKEY		_IO(IB_IOCTL_MAGIC, 3)
-
-#define IB_USER_MAD_REGISTER_AGENT2     _IOWR(IB_IOCTL_MAGIC, 4, \
-					      struct ib_user_mad_reg_req2)
-
 #endif /* IB_USER_MAD_H */
diff --git a/include/uapi/rdma/rdma_user_ioctl.h b/include/uapi/rdma/rdma_user_ioctl.h
new file mode 100644
index 0000000..5c1117a
--- /dev/null
+++ b/include/uapi/rdma/rdma_user_ioctl.h
@@ -0,0 +1,59 @@ 
+/*
+ * Copyright (c) 2016 Mellanox Technologies, LTD. 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.
+ */
+
+#ifndef RDMA_USER_IOCTL_H
+#define RDMA_USER_IOCTL_H
+
+#include <linux/types.h>
+#include <linux/ioctl.h>
+
+#define RDMA_IOCTL_MAGIC		0x1b
+/*
+ * For hfi1 driver
+ */
+#define IB_IOCTL_MAGIC			RDMA_IOCTL_MAGIC
+
+/* Legacy part
+ * !!!! NOTE: It uses the same command index as VERBS
+ */
+#include <rdma/ib_user_mad.h>
+#define IB_USER_MAD_REGISTER_AGENT	_IOWR(RDMA_IOCTL_MAGIC, 1, \
+					      struct ib_user_mad_reg_req)
+
+#define IB_USER_MAD_UNREGISTER_AGENT	_IOW(RDMA_IOCTL_MAGIC, 2, __u32)
+
+#define IB_USER_MAD_ENABLE_PKEY		_IO(RDMA_IOCTL_MAGIC, 3)
+
+#define IB_USER_MAD_REGISTER_AGENT2     _IOWR(RDMA_IOCTL_MAGIC, 4, \
+					      struct ib_user_mad_reg_req2)
+
+#endif /* RDMA_USER_IOCTL_H */