2005-07-07 18:57:13 -06:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2005 Topspin Communications. All rights reserved.
|
2006-01-30 15:29:21 -07:00
|
|
|
* Copyright (c) 2005, 2006 Cisco Systems. All rights reserved.
|
2005-08-11 00:03:10 -06:00
|
|
|
* Copyright (c) 2005 Mellanox Technologies. All rights reserved.
|
|
|
|
* Copyright (c) 2005 Voltaire, Inc. All rights reserved.
|
2005-10-14 16:26:04 -06:00
|
|
|
* Copyright (c) 2005 PathScale, Inc. All rights reserved.
|
2005-07-07 18:57:13 -06:00
|
|
|
*
|
|
|
|
* 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 UVERBS_H
|
|
|
|
#define UVERBS_H
|
|
|
|
|
|
|
|
#include <linux/kref.h>
|
|
|
|
#include <linux/idr.h>
|
2006-01-13 15:51:39 -07:00
|
|
|
#include <linux/mutex.h>
|
2006-08-03 11:56:42 -06:00
|
|
|
#include <linux/completion.h>
|
2010-02-02 12:07:49 -07:00
|
|
|
#include <linux/cdev.h>
|
2005-07-07 18:57:13 -06:00
|
|
|
|
2005-08-25 14:40:04 -06:00
|
|
|
#include <rdma/ib_verbs.h>
|
2007-03-04 17:15:11 -07:00
|
|
|
#include <rdma/ib_umem.h>
|
2005-08-25 14:40:04 -06:00
|
|
|
#include <rdma/ib_user_verbs.h>
|
2005-07-07 18:57:13 -06:00
|
|
|
|
IB/core: extended command: an improved infrastructure for uverbs commands
Commit 400dbc96583f ("IB/core: Infrastructure for extensible uverbs
commands") added an infrastructure for extensible uverbs commands
while later commit 436f2ad05a0b ("IB/core: Export ib_create/destroy_flow
through uverbs") exported ib_create_flow()/ib_destroy_flow() functions
using this new infrastructure.
According to the commit 400dbc96583f, the purpose of this
infrastructure is to support passing around provider (eg. hardware)
specific buffers when userspace issue commands to the kernel, so that
it would be possible to extend uverbs (eg. core) buffers independently
from the provider buffers.
But the new kernel command function prototypes were not modified to
take advantage of this extension. This issue was exposed by Roland
Dreier in a previous review[1].
So the following patch is an attempt to a revised extensible command
infrastructure.
This improved extensible command infrastructure distinguish between
core (eg. legacy)'s command/response buffers from provider
(eg. hardware)'s command/response buffers: each extended command
implementing function is given a struct ib_udata to hold core
(eg. uverbs) input and output buffers, and another struct ib_udata to
hold the hw (eg. provider) input and output buffers.
Having those buffers identified separately make it easier to increase
one buffer to support extension without having to add some code to
guess the exact size of each command/response parts: This should make
the extended functions more reliable.
Additionally, instead of relying on command identifier being greater
than IB_USER_VERBS_CMD_THRESHOLD, the proposed infrastructure rely on
unused bits in command field: on the 32 bits provided by command
field, only 6 bits are really needed to encode the identifier of
commands currently supported by the kernel. (Even using only 6 bits
leaves room for about 23 new commands).
So this patch makes use of some high order bits in command field to
store flags, leaving enough room for more command identifiers than one
will ever need (eg. 256).
The new flags are used to specify if the command should be processed
as an extended one or a legacy one. While designing the new command
format, care was taken to make usage of flags itself extensible.
Using high order bits of the commands field ensure that newer
libibverbs on older kernel will properly fail when trying to call
extended commands. On the other hand, older libibverbs on newer kernel
will never be able to issue calls to extended commands.
The extended command header includes the optional response pointer so
that output buffer length and output buffer pointer are located
together in the command, allowing proper parameters checking. This
should make implementing functions easier and safer.
Additionally the extended header ensure 64bits alignment, while making
all sizes multiple of 8 bytes, extending the maximum buffer size:
legacy extended
Maximum command buffer: 256KBytes 1024KBytes (512KBytes + 512KBytes)
Maximum response buffer: 256KBytes 1024KBytes (512KBytes + 512KBytes)
For the purpose of doing proper buffer size accounting, the headers
size are no more taken in account in "in_words".
One of the odds of the current extensible infrastructure, reading
twice the "legacy" command header, is fixed by removing the "legacy"
command header from the extended command header: they are processed as
two different parts of the command: memory is read once and
information are not duplicated: it's making clear that's an extended
command scheme and not a different command scheme.
The proposed scheme will format input (command) and output (response)
buffers this way:
- command:
legacy header +
extended header +
command data (core + hw):
+----------------------------------------+
| flags | 00 00 | command |
| in_words | out_words |
+----------------------------------------+
| response |
| response |
| provider_in_words | provider_out_words |
| padding |
+----------------------------------------+
| |
. <uverbs input> .
. (in_words * 8) .
| |
+----------------------------------------+
| |
. <provider input> .
. (provider_in_words * 8) .
| |
+----------------------------------------+
- response, if present:
+----------------------------------------+
| |
. <uverbs output space> .
. (out_words * 8) .
| |
+----------------------------------------+
| |
. <provider output space> .
. (provider_out_words * 8) .
| |
+----------------------------------------+
The overall design is to ensure that the extensible infrastructure is
itself extensible while begin more reliable with more input and bound
checking.
Note:
The unused field in the extended header would be perfect candidate to
hold the command "comp_mask" (eg. bit field used to handle
compatibility). This was suggested by Roland Dreier in a previous
review[2]. But "comp_mask" field is likely to be present in the uverb
input and/or provider input, likewise for the response, as noted by
Matan Barak[3], so it doesn't make sense to put "comp_mask" in the
header.
[1]:
http://marc.info/?i=CAL1RGDWxmM17W2o_era24A-TTDeKyoL6u3NRu_=t_dhV_ZA9MA@mail.gmail.com
[2]:
http://marc.info/?i=CAL1RGDXJtrc849M6_XNZT5xO1+ybKtLWGq6yg6LhoSsKpsmkYA@mail.gmail.com
[3]:
http://marc.info/?i=525C1149.6000701@mellanox.com
Signed-off-by: Yann Droneaud <ydroneaud@opteya.com>
Link: http://marc.info/?i=cover.1383773832.git.ydroneaud@opteya.com
[ Convert "ret ? ret : 0" to the equivalent "ret". - Roland ]
Signed-off-by: Roland Dreier <roland@purestorage.com>
2013-11-06 15:21:49 -07:00
|
|
|
#define INIT_UDATA(udata, ibuf, obuf, ilen, olen) \
|
|
|
|
do { \
|
2013-12-11 15:01:44 -07:00
|
|
|
(udata)->inbuf = (const void __user *) (ibuf); \
|
IB/core: extended command: an improved infrastructure for uverbs commands
Commit 400dbc96583f ("IB/core: Infrastructure for extensible uverbs
commands") added an infrastructure for extensible uverbs commands
while later commit 436f2ad05a0b ("IB/core: Export ib_create/destroy_flow
through uverbs") exported ib_create_flow()/ib_destroy_flow() functions
using this new infrastructure.
According to the commit 400dbc96583f, the purpose of this
infrastructure is to support passing around provider (eg. hardware)
specific buffers when userspace issue commands to the kernel, so that
it would be possible to extend uverbs (eg. core) buffers independently
from the provider buffers.
But the new kernel command function prototypes were not modified to
take advantage of this extension. This issue was exposed by Roland
Dreier in a previous review[1].
So the following patch is an attempt to a revised extensible command
infrastructure.
This improved extensible command infrastructure distinguish between
core (eg. legacy)'s command/response buffers from provider
(eg. hardware)'s command/response buffers: each extended command
implementing function is given a struct ib_udata to hold core
(eg. uverbs) input and output buffers, and another struct ib_udata to
hold the hw (eg. provider) input and output buffers.
Having those buffers identified separately make it easier to increase
one buffer to support extension without having to add some code to
guess the exact size of each command/response parts: This should make
the extended functions more reliable.
Additionally, instead of relying on command identifier being greater
than IB_USER_VERBS_CMD_THRESHOLD, the proposed infrastructure rely on
unused bits in command field: on the 32 bits provided by command
field, only 6 bits are really needed to encode the identifier of
commands currently supported by the kernel. (Even using only 6 bits
leaves room for about 23 new commands).
So this patch makes use of some high order bits in command field to
store flags, leaving enough room for more command identifiers than one
will ever need (eg. 256).
The new flags are used to specify if the command should be processed
as an extended one or a legacy one. While designing the new command
format, care was taken to make usage of flags itself extensible.
Using high order bits of the commands field ensure that newer
libibverbs on older kernel will properly fail when trying to call
extended commands. On the other hand, older libibverbs on newer kernel
will never be able to issue calls to extended commands.
The extended command header includes the optional response pointer so
that output buffer length and output buffer pointer are located
together in the command, allowing proper parameters checking. This
should make implementing functions easier and safer.
Additionally the extended header ensure 64bits alignment, while making
all sizes multiple of 8 bytes, extending the maximum buffer size:
legacy extended
Maximum command buffer: 256KBytes 1024KBytes (512KBytes + 512KBytes)
Maximum response buffer: 256KBytes 1024KBytes (512KBytes + 512KBytes)
For the purpose of doing proper buffer size accounting, the headers
size are no more taken in account in "in_words".
One of the odds of the current extensible infrastructure, reading
twice the "legacy" command header, is fixed by removing the "legacy"
command header from the extended command header: they are processed as
two different parts of the command: memory is read once and
information are not duplicated: it's making clear that's an extended
command scheme and not a different command scheme.
The proposed scheme will format input (command) and output (response)
buffers this way:
- command:
legacy header +
extended header +
command data (core + hw):
+----------------------------------------+
| flags | 00 00 | command |
| in_words | out_words |
+----------------------------------------+
| response |
| response |
| provider_in_words | provider_out_words |
| padding |
+----------------------------------------+
| |
. <uverbs input> .
. (in_words * 8) .
| |
+----------------------------------------+
| |
. <provider input> .
. (provider_in_words * 8) .
| |
+----------------------------------------+
- response, if present:
+----------------------------------------+
| |
. <uverbs output space> .
. (out_words * 8) .
| |
+----------------------------------------+
| |
. <provider output space> .
. (provider_out_words * 8) .
| |
+----------------------------------------+
The overall design is to ensure that the extensible infrastructure is
itself extensible while begin more reliable with more input and bound
checking.
Note:
The unused field in the extended header would be perfect candidate to
hold the command "comp_mask" (eg. bit field used to handle
compatibility). This was suggested by Roland Dreier in a previous
review[2]. But "comp_mask" field is likely to be present in the uverb
input and/or provider input, likewise for the response, as noted by
Matan Barak[3], so it doesn't make sense to put "comp_mask" in the
header.
[1]:
http://marc.info/?i=CAL1RGDWxmM17W2o_era24A-TTDeKyoL6u3NRu_=t_dhV_ZA9MA@mail.gmail.com
[2]:
http://marc.info/?i=CAL1RGDXJtrc849M6_XNZT5xO1+ybKtLWGq6yg6LhoSsKpsmkYA@mail.gmail.com
[3]:
http://marc.info/?i=525C1149.6000701@mellanox.com
Signed-off-by: Yann Droneaud <ydroneaud@opteya.com>
Link: http://marc.info/?i=cover.1383773832.git.ydroneaud@opteya.com
[ Convert "ret ? ret : 0" to the equivalent "ret". - Roland ]
Signed-off-by: Roland Dreier <roland@purestorage.com>
2013-11-06 15:21:49 -07:00
|
|
|
(udata)->outbuf = (void __user *) (obuf); \
|
|
|
|
(udata)->inlen = (ilen); \
|
|
|
|
(udata)->outlen = (olen); \
|
|
|
|
} while (0)
|
|
|
|
|
2013-12-19 09:37:03 -07:00
|
|
|
#define INIT_UDATA_BUF_OR_NULL(udata, ibuf, obuf, ilen, olen) \
|
|
|
|
do { \
|
|
|
|
(udata)->inbuf = (ilen) ? (const void __user *) (ibuf) : NULL; \
|
|
|
|
(udata)->outbuf = (olen) ? (void __user *) (obuf) : NULL; \
|
|
|
|
(udata)->inlen = (ilen); \
|
|
|
|
(udata)->outlen = (olen); \
|
|
|
|
} while (0)
|
|
|
|
|
2005-10-28 16:38:26 -06:00
|
|
|
/*
|
|
|
|
* Our lifetime rules for these structs are the following:
|
|
|
|
*
|
|
|
|
* struct ib_uverbs_device: One reference is held by the module and
|
|
|
|
* released in ib_uverbs_remove_one(). Another reference is taken by
|
|
|
|
* ib_uverbs_open() each time the character special file is opened,
|
|
|
|
* and released in ib_uverbs_release_file() when the file is released.
|
|
|
|
*
|
|
|
|
* struct ib_uverbs_file: One reference is held by the VFS and
|
|
|
|
* released when the file is closed. Another reference is taken when
|
|
|
|
* an asynchronous event queue file is created and released when the
|
|
|
|
* event file is closed.
|
|
|
|
*
|
2017-04-18 03:03:42 -06:00
|
|
|
* struct ib_uverbs_event_queue: Base structure for
|
|
|
|
* struct ib_uverbs_async_event_file and struct ib_uverbs_completion_event_file.
|
|
|
|
* One reference is held by the VFS and released when the file is closed.
|
|
|
|
* For asynchronous event files, another reference is held by the corresponding
|
|
|
|
* main context file and released when that file is closed. For completion
|
|
|
|
* event files, a reference is taken when a CQ is created that uses the file,
|
|
|
|
* and released when the CQ is destroyed.
|
2005-10-28 16:38:26 -06:00
|
|
|
*/
|
|
|
|
|
2005-07-07 18:57:13 -06:00
|
|
|
struct ib_uverbs_device {
|
2015-08-13 09:32:03 -06:00
|
|
|
atomic_t refcount;
|
2010-02-02 12:07:49 -07:00
|
|
|
int num_comp_vectors;
|
2006-08-03 11:56:42 -06:00
|
|
|
struct completion comp;
|
2008-02-21 16:13:36 -07:00
|
|
|
struct device *dev;
|
2015-08-13 09:32:05 -06:00
|
|
|
struct ib_device __rcu *ib_dev;
|
2010-02-02 12:07:49 -07:00
|
|
|
int devnum;
|
|
|
|
struct cdev cdev;
|
2011-05-24 09:33:46 -06:00
|
|
|
struct rb_root xrcd_tree;
|
|
|
|
struct mutex xrcd_tree_mutex;
|
2015-08-13 09:32:03 -06:00
|
|
|
struct kobject kobj;
|
2015-08-13 09:32:05 -06:00
|
|
|
struct srcu_struct disassociate_srcu;
|
|
|
|
struct mutex lists_mutex; /* protect lists */
|
|
|
|
struct list_head uverbs_file_list;
|
|
|
|
struct list_head uverbs_events_file_list;
|
2017-08-03 07:07:06 -06:00
|
|
|
struct uverbs_root_spec *specs_root;
|
2005-07-07 18:57:13 -06:00
|
|
|
};
|
|
|
|
|
2017-04-18 03:03:42 -06:00
|
|
|
struct ib_uverbs_event_queue {
|
2005-07-07 18:57:13 -06:00
|
|
|
spinlock_t lock;
|
2010-02-02 12:08:14 -07:00
|
|
|
int is_closed;
|
2005-07-07 18:57:13 -06:00
|
|
|
wait_queue_head_t poll_wait;
|
2005-07-27 15:40:00 -06:00
|
|
|
struct fasync_struct *async_queue;
|
2005-07-07 18:57:13 -06:00
|
|
|
struct list_head event_list;
|
2017-04-04 04:31:47 -06:00
|
|
|
};
|
|
|
|
|
|
|
|
struct ib_uverbs_async_event_file {
|
2017-04-18 03:03:42 -06:00
|
|
|
struct ib_uverbs_event_queue ev_queue;
|
2017-04-04 04:31:47 -06:00
|
|
|
struct ib_uverbs_file *uverbs_file;
|
|
|
|
struct kref ref;
|
2015-08-13 09:32:05 -06:00
|
|
|
struct list_head list;
|
2005-07-07 18:57:13 -06:00
|
|
|
};
|
|
|
|
|
2017-04-04 04:31:47 -06:00
|
|
|
struct ib_uverbs_completion_event_file {
|
|
|
|
struct ib_uobject_file uobj_file;
|
2017-04-18 03:03:42 -06:00
|
|
|
struct ib_uverbs_event_queue ev_queue;
|
2017-04-04 04:31:47 -06:00
|
|
|
};
|
|
|
|
|
2005-07-07 18:57:13 -06:00
|
|
|
struct ib_uverbs_file {
|
|
|
|
struct kref ref;
|
2006-01-13 15:51:39 -07:00
|
|
|
struct mutex mutex;
|
2016-07-03 06:28:18 -06:00
|
|
|
struct mutex cleanup_mutex; /* protect cleanup */
|
2005-07-07 18:57:13 -06:00
|
|
|
struct ib_uverbs_device *device;
|
|
|
|
struct ib_ucontext *ucontext;
|
|
|
|
struct ib_event_handler event_handler;
|
2017-04-04 04:31:47 -06:00
|
|
|
struct ib_uverbs_async_event_file *async_file;
|
2015-08-13 09:32:05 -06:00
|
|
|
struct list_head list;
|
|
|
|
int is_closed;
|
2017-04-04 04:31:41 -06:00
|
|
|
|
|
|
|
struct idr idr;
|
|
|
|
/* spinlock protects write access to idr */
|
|
|
|
spinlock_t idr_lock;
|
2005-07-07 18:57:13 -06:00
|
|
|
};
|
|
|
|
|
2005-09-09 16:55:08 -06:00
|
|
|
struct ib_uverbs_event {
|
|
|
|
union {
|
|
|
|
struct ib_uverbs_async_event_desc async;
|
|
|
|
struct ib_uverbs_comp_event_desc comp;
|
|
|
|
} desc;
|
2005-07-07 18:57:13 -06:00
|
|
|
struct list_head list;
|
2005-09-09 16:55:08 -06:00
|
|
|
struct list_head obj_list;
|
|
|
|
u32 *counter;
|
2005-07-07 18:57:13 -06:00
|
|
|
};
|
|
|
|
|
2005-11-29 17:57:01 -07:00
|
|
|
struct ib_uverbs_mcast_entry {
|
|
|
|
struct list_head list;
|
|
|
|
union ib_gid gid;
|
|
|
|
u16 lid;
|
|
|
|
};
|
|
|
|
|
2005-09-09 16:55:08 -06:00
|
|
|
struct ib_uevent_object {
|
|
|
|
struct ib_uobject uobject;
|
|
|
|
struct list_head event_list;
|
|
|
|
u32 events_reported;
|
2005-07-07 18:57:13 -06:00
|
|
|
};
|
|
|
|
|
2011-05-24 09:33:46 -06:00
|
|
|
struct ib_uxrcd_object {
|
|
|
|
struct ib_uobject uobject;
|
|
|
|
atomic_t refcnt;
|
|
|
|
};
|
|
|
|
|
2011-05-25 18:08:38 -06:00
|
|
|
struct ib_usrq_object {
|
|
|
|
struct ib_uevent_object uevent;
|
|
|
|
struct ib_uxrcd_object *uxrcd;
|
|
|
|
};
|
|
|
|
|
2005-11-29 17:57:01 -07:00
|
|
|
struct ib_uqp_object {
|
|
|
|
struct ib_uevent_object uevent;
|
2017-04-04 04:31:45 -06:00
|
|
|
/* lock for mcast list */
|
|
|
|
struct mutex mcast_lock;
|
2005-11-29 17:57:01 -07:00
|
|
|
struct list_head mcast_list;
|
2013-08-01 09:49:54 -06:00
|
|
|
struct ib_uxrcd_object *uxrcd;
|
2005-11-29 17:57:01 -07:00
|
|
|
};
|
|
|
|
|
2016-05-23 06:20:49 -06:00
|
|
|
struct ib_uwq_object {
|
|
|
|
struct ib_uevent_object uevent;
|
|
|
|
};
|
|
|
|
|
2005-09-09 16:55:08 -06:00
|
|
|
struct ib_ucq_object {
|
|
|
|
struct ib_uobject uobject;
|
2005-10-30 10:50:04 -07:00
|
|
|
struct ib_uverbs_file *uverbs_file;
|
2005-09-09 16:55:08 -06:00
|
|
|
struct list_head comp_list;
|
|
|
|
struct list_head async_list;
|
|
|
|
u32 comp_events_reported;
|
|
|
|
u32 async_events_reported;
|
2005-07-07 18:57:13 -06:00
|
|
|
};
|
|
|
|
|
2017-04-04 04:31:47 -06:00
|
|
|
extern const struct file_operations uverbs_event_fops;
|
2017-04-18 03:03:42 -06:00
|
|
|
void ib_uverbs_init_event_queue(struct ib_uverbs_event_queue *ev_queue);
|
2017-04-04 04:31:47 -06:00
|
|
|
struct file *ib_uverbs_alloc_async_event_file(struct ib_uverbs_file *uverbs_file,
|
|
|
|
struct ib_device *ib_dev);
|
2015-08-13 09:32:02 -06:00
|
|
|
void ib_uverbs_free_async_event_file(struct ib_uverbs_file *uverbs_file);
|
2005-09-26 14:53:25 -06:00
|
|
|
|
2005-10-28 16:38:26 -06:00
|
|
|
void ib_uverbs_release_ucq(struct ib_uverbs_file *file,
|
2017-04-04 04:31:47 -06:00
|
|
|
struct ib_uverbs_completion_event_file *ev_file,
|
2005-10-28 16:38:26 -06:00
|
|
|
struct ib_ucq_object *uobj);
|
|
|
|
void ib_uverbs_release_uevent(struct ib_uverbs_file *file,
|
|
|
|
struct ib_uevent_object *uobj);
|
2017-04-04 04:31:46 -06:00
|
|
|
void ib_uverbs_release_file(struct kref *ref);
|
2005-10-28 16:38:26 -06:00
|
|
|
|
2005-07-07 18:57:13 -06:00
|
|
|
void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context);
|
|
|
|
void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr);
|
|
|
|
void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr);
|
2016-05-23 06:20:49 -06:00
|
|
|
void ib_uverbs_wq_event_handler(struct ib_event *event, void *context_ptr);
|
2005-08-18 13:24:13 -06:00
|
|
|
void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr);
|
2005-09-26 14:53:25 -06:00
|
|
|
void ib_uverbs_event_handler(struct ib_event_handler *handler,
|
|
|
|
struct ib_event *event);
|
2017-04-04 04:31:43 -06:00
|
|
|
int ib_uverbs_dealloc_xrcd(struct ib_uverbs_device *dev, struct ib_xrcd *xrcd,
|
|
|
|
enum rdma_remove_reason why);
|
2005-07-07 18:57:13 -06:00
|
|
|
|
2015-12-23 11:12:48 -07:00
|
|
|
int uverbs_dealloc_mw(struct ib_mw *mw);
|
2017-04-04 04:31:43 -06:00
|
|
|
void ib_uverbs_detach_umcast(struct ib_qp *qp,
|
|
|
|
struct ib_uqp_object *uobj);
|
2015-12-23 11:12:48 -07:00
|
|
|
|
2017-08-03 07:07:07 -06:00
|
|
|
long ib_uverbs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
|
|
|
|
|
2013-11-06 15:21:48 -07:00
|
|
|
struct ib_uverbs_flow_spec {
|
|
|
|
union {
|
|
|
|
union {
|
|
|
|
struct ib_uverbs_flow_spec_hdr hdr;
|
|
|
|
struct {
|
|
|
|
__u32 type;
|
|
|
|
__u16 size;
|
|
|
|
__u16 reserved;
|
|
|
|
};
|
|
|
|
};
|
|
|
|
struct ib_uverbs_flow_spec_eth eth;
|
|
|
|
struct ib_uverbs_flow_spec_ipv4 ipv4;
|
|
|
|
struct ib_uverbs_flow_spec_tcp_udp tcp_udp;
|
2016-06-17 06:14:50 -06:00
|
|
|
struct ib_uverbs_flow_spec_ipv6 ipv6;
|
2017-01-18 05:59:49 -07:00
|
|
|
struct ib_uverbs_flow_spec_action_tag flow_tag;
|
2017-04-03 04:13:51 -06:00
|
|
|
struct ib_uverbs_flow_spec_action_drop drop;
|
2013-11-06 15:21:48 -07:00
|
|
|
};
|
|
|
|
};
|
|
|
|
|
2005-07-07 18:57:13 -06:00
|
|
|
#define IB_UVERBS_DECLARE_CMD(name) \
|
|
|
|
ssize_t ib_uverbs_##name(struct ib_uverbs_file *file, \
|
2015-08-13 09:32:04 -06:00
|
|
|
struct ib_device *ib_dev, \
|
2005-07-07 18:57:13 -06:00
|
|
|
const char __user *buf, int in_len, \
|
|
|
|
int out_len)
|
|
|
|
|
|
|
|
IB_UVERBS_DECLARE_CMD(get_context);
|
|
|
|
IB_UVERBS_DECLARE_CMD(query_device);
|
|
|
|
IB_UVERBS_DECLARE_CMD(query_port);
|
|
|
|
IB_UVERBS_DECLARE_CMD(alloc_pd);
|
|
|
|
IB_UVERBS_DECLARE_CMD(dealloc_pd);
|
|
|
|
IB_UVERBS_DECLARE_CMD(reg_mr);
|
2014-07-31 02:01:28 -06:00
|
|
|
IB_UVERBS_DECLARE_CMD(rereg_mr);
|
2005-07-07 18:57:13 -06:00
|
|
|
IB_UVERBS_DECLARE_CMD(dereg_mr);
|
2013-02-06 09:19:13 -07:00
|
|
|
IB_UVERBS_DECLARE_CMD(alloc_mw);
|
|
|
|
IB_UVERBS_DECLARE_CMD(dealloc_mw);
|
2005-09-26 14:53:25 -06:00
|
|
|
IB_UVERBS_DECLARE_CMD(create_comp_channel);
|
2005-07-07 18:57:13 -06:00
|
|
|
IB_UVERBS_DECLARE_CMD(create_cq);
|
2006-01-30 15:29:21 -07:00
|
|
|
IB_UVERBS_DECLARE_CMD(resize_cq);
|
2005-10-14 16:26:04 -06:00
|
|
|
IB_UVERBS_DECLARE_CMD(poll_cq);
|
|
|
|
IB_UVERBS_DECLARE_CMD(req_notify_cq);
|
2005-07-07 18:57:13 -06:00
|
|
|
IB_UVERBS_DECLARE_CMD(destroy_cq);
|
|
|
|
IB_UVERBS_DECLARE_CMD(create_qp);
|
2011-08-11 14:57:43 -06:00
|
|
|
IB_UVERBS_DECLARE_CMD(open_qp);
|
2006-02-13 17:31:25 -07:00
|
|
|
IB_UVERBS_DECLARE_CMD(query_qp);
|
2005-07-07 18:57:13 -06:00
|
|
|
IB_UVERBS_DECLARE_CMD(modify_qp);
|
|
|
|
IB_UVERBS_DECLARE_CMD(destroy_qp);
|
2005-10-14 16:26:04 -06:00
|
|
|
IB_UVERBS_DECLARE_CMD(post_send);
|
|
|
|
IB_UVERBS_DECLARE_CMD(post_recv);
|
|
|
|
IB_UVERBS_DECLARE_CMD(post_srq_recv);
|
|
|
|
IB_UVERBS_DECLARE_CMD(create_ah);
|
|
|
|
IB_UVERBS_DECLARE_CMD(destroy_ah);
|
2005-07-07 18:57:13 -06:00
|
|
|
IB_UVERBS_DECLARE_CMD(attach_mcast);
|
|
|
|
IB_UVERBS_DECLARE_CMD(detach_mcast);
|
2005-08-18 13:24:13 -06:00
|
|
|
IB_UVERBS_DECLARE_CMD(create_srq);
|
|
|
|
IB_UVERBS_DECLARE_CMD(modify_srq);
|
2006-02-13 17:31:57 -07:00
|
|
|
IB_UVERBS_DECLARE_CMD(query_srq);
|
2005-08-18 13:24:13 -06:00
|
|
|
IB_UVERBS_DECLARE_CMD(destroy_srq);
|
2011-05-25 18:08:38 -06:00
|
|
|
IB_UVERBS_DECLARE_CMD(create_xsrq);
|
2011-05-24 09:33:46 -06:00
|
|
|
IB_UVERBS_DECLARE_CMD(open_xrcd);
|
|
|
|
IB_UVERBS_DECLARE_CMD(close_xrcd);
|
IB/core: extended command: an improved infrastructure for uverbs commands
Commit 400dbc96583f ("IB/core: Infrastructure for extensible uverbs
commands") added an infrastructure for extensible uverbs commands
while later commit 436f2ad05a0b ("IB/core: Export ib_create/destroy_flow
through uverbs") exported ib_create_flow()/ib_destroy_flow() functions
using this new infrastructure.
According to the commit 400dbc96583f, the purpose of this
infrastructure is to support passing around provider (eg. hardware)
specific buffers when userspace issue commands to the kernel, so that
it would be possible to extend uverbs (eg. core) buffers independently
from the provider buffers.
But the new kernel command function prototypes were not modified to
take advantage of this extension. This issue was exposed by Roland
Dreier in a previous review[1].
So the following patch is an attempt to a revised extensible command
infrastructure.
This improved extensible command infrastructure distinguish between
core (eg. legacy)'s command/response buffers from provider
(eg. hardware)'s command/response buffers: each extended command
implementing function is given a struct ib_udata to hold core
(eg. uverbs) input and output buffers, and another struct ib_udata to
hold the hw (eg. provider) input and output buffers.
Having those buffers identified separately make it easier to increase
one buffer to support extension without having to add some code to
guess the exact size of each command/response parts: This should make
the extended functions more reliable.
Additionally, instead of relying on command identifier being greater
than IB_USER_VERBS_CMD_THRESHOLD, the proposed infrastructure rely on
unused bits in command field: on the 32 bits provided by command
field, only 6 bits are really needed to encode the identifier of
commands currently supported by the kernel. (Even using only 6 bits
leaves room for about 23 new commands).
So this patch makes use of some high order bits in command field to
store flags, leaving enough room for more command identifiers than one
will ever need (eg. 256).
The new flags are used to specify if the command should be processed
as an extended one or a legacy one. While designing the new command
format, care was taken to make usage of flags itself extensible.
Using high order bits of the commands field ensure that newer
libibverbs on older kernel will properly fail when trying to call
extended commands. On the other hand, older libibverbs on newer kernel
will never be able to issue calls to extended commands.
The extended command header includes the optional response pointer so
that output buffer length and output buffer pointer are located
together in the command, allowing proper parameters checking. This
should make implementing functions easier and safer.
Additionally the extended header ensure 64bits alignment, while making
all sizes multiple of 8 bytes, extending the maximum buffer size:
legacy extended
Maximum command buffer: 256KBytes 1024KBytes (512KBytes + 512KBytes)
Maximum response buffer: 256KBytes 1024KBytes (512KBytes + 512KBytes)
For the purpose of doing proper buffer size accounting, the headers
size are no more taken in account in "in_words".
One of the odds of the current extensible infrastructure, reading
twice the "legacy" command header, is fixed by removing the "legacy"
command header from the extended command header: they are processed as
two different parts of the command: memory is read once and
information are not duplicated: it's making clear that's an extended
command scheme and not a different command scheme.
The proposed scheme will format input (command) and output (response)
buffers this way:
- command:
legacy header +
extended header +
command data (core + hw):
+----------------------------------------+
| flags | 00 00 | command |
| in_words | out_words |
+----------------------------------------+
| response |
| response |
| provider_in_words | provider_out_words |
| padding |
+----------------------------------------+
| |
. <uverbs input> .
. (in_words * 8) .
| |
+----------------------------------------+
| |
. <provider input> .
. (provider_in_words * 8) .
| |
+----------------------------------------+
- response, if present:
+----------------------------------------+
| |
. <uverbs output space> .
. (out_words * 8) .
| |
+----------------------------------------+
| |
. <provider output space> .
. (provider_out_words * 8) .
| |
+----------------------------------------+
The overall design is to ensure that the extensible infrastructure is
itself extensible while begin more reliable with more input and bound
checking.
Note:
The unused field in the extended header would be perfect candidate to
hold the command "comp_mask" (eg. bit field used to handle
compatibility). This was suggested by Roland Dreier in a previous
review[2]. But "comp_mask" field is likely to be present in the uverb
input and/or provider input, likewise for the response, as noted by
Matan Barak[3], so it doesn't make sense to put "comp_mask" in the
header.
[1]:
http://marc.info/?i=CAL1RGDWxmM17W2o_era24A-TTDeKyoL6u3NRu_=t_dhV_ZA9MA@mail.gmail.com
[2]:
http://marc.info/?i=CAL1RGDXJtrc849M6_XNZT5xO1+ybKtLWGq6yg6LhoSsKpsmkYA@mail.gmail.com
[3]:
http://marc.info/?i=525C1149.6000701@mellanox.com
Signed-off-by: Yann Droneaud <ydroneaud@opteya.com>
Link: http://marc.info/?i=cover.1383773832.git.ydroneaud@opteya.com
[ Convert "ret ? ret : 0" to the equivalent "ret". - Roland ]
Signed-off-by: Roland Dreier <roland@purestorage.com>
2013-11-06 15:21:49 -07:00
|
|
|
|
|
|
|
#define IB_UVERBS_DECLARE_EX_CMD(name) \
|
|
|
|
int ib_uverbs_ex_##name(struct ib_uverbs_file *file, \
|
2015-08-13 09:32:04 -06:00
|
|
|
struct ib_device *ib_dev, \
|
IB/core: extended command: an improved infrastructure for uverbs commands
Commit 400dbc96583f ("IB/core: Infrastructure for extensible uverbs
commands") added an infrastructure for extensible uverbs commands
while later commit 436f2ad05a0b ("IB/core: Export ib_create/destroy_flow
through uverbs") exported ib_create_flow()/ib_destroy_flow() functions
using this new infrastructure.
According to the commit 400dbc96583f, the purpose of this
infrastructure is to support passing around provider (eg. hardware)
specific buffers when userspace issue commands to the kernel, so that
it would be possible to extend uverbs (eg. core) buffers independently
from the provider buffers.
But the new kernel command function prototypes were not modified to
take advantage of this extension. This issue was exposed by Roland
Dreier in a previous review[1].
So the following patch is an attempt to a revised extensible command
infrastructure.
This improved extensible command infrastructure distinguish between
core (eg. legacy)'s command/response buffers from provider
(eg. hardware)'s command/response buffers: each extended command
implementing function is given a struct ib_udata to hold core
(eg. uverbs) input and output buffers, and another struct ib_udata to
hold the hw (eg. provider) input and output buffers.
Having those buffers identified separately make it easier to increase
one buffer to support extension without having to add some code to
guess the exact size of each command/response parts: This should make
the extended functions more reliable.
Additionally, instead of relying on command identifier being greater
than IB_USER_VERBS_CMD_THRESHOLD, the proposed infrastructure rely on
unused bits in command field: on the 32 bits provided by command
field, only 6 bits are really needed to encode the identifier of
commands currently supported by the kernel. (Even using only 6 bits
leaves room for about 23 new commands).
So this patch makes use of some high order bits in command field to
store flags, leaving enough room for more command identifiers than one
will ever need (eg. 256).
The new flags are used to specify if the command should be processed
as an extended one or a legacy one. While designing the new command
format, care was taken to make usage of flags itself extensible.
Using high order bits of the commands field ensure that newer
libibverbs on older kernel will properly fail when trying to call
extended commands. On the other hand, older libibverbs on newer kernel
will never be able to issue calls to extended commands.
The extended command header includes the optional response pointer so
that output buffer length and output buffer pointer are located
together in the command, allowing proper parameters checking. This
should make implementing functions easier and safer.
Additionally the extended header ensure 64bits alignment, while making
all sizes multiple of 8 bytes, extending the maximum buffer size:
legacy extended
Maximum command buffer: 256KBytes 1024KBytes (512KBytes + 512KBytes)
Maximum response buffer: 256KBytes 1024KBytes (512KBytes + 512KBytes)
For the purpose of doing proper buffer size accounting, the headers
size are no more taken in account in "in_words".
One of the odds of the current extensible infrastructure, reading
twice the "legacy" command header, is fixed by removing the "legacy"
command header from the extended command header: they are processed as
two different parts of the command: memory is read once and
information are not duplicated: it's making clear that's an extended
command scheme and not a different command scheme.
The proposed scheme will format input (command) and output (response)
buffers this way:
- command:
legacy header +
extended header +
command data (core + hw):
+----------------------------------------+
| flags | 00 00 | command |
| in_words | out_words |
+----------------------------------------+
| response |
| response |
| provider_in_words | provider_out_words |
| padding |
+----------------------------------------+
| |
. <uverbs input> .
. (in_words * 8) .
| |
+----------------------------------------+
| |
. <provider input> .
. (provider_in_words * 8) .
| |
+----------------------------------------+
- response, if present:
+----------------------------------------+
| |
. <uverbs output space> .
. (out_words * 8) .
| |
+----------------------------------------+
| |
. <provider output space> .
. (provider_out_words * 8) .
| |
+----------------------------------------+
The overall design is to ensure that the extensible infrastructure is
itself extensible while begin more reliable with more input and bound
checking.
Note:
The unused field in the extended header would be perfect candidate to
hold the command "comp_mask" (eg. bit field used to handle
compatibility). This was suggested by Roland Dreier in a previous
review[2]. But "comp_mask" field is likely to be present in the uverb
input and/or provider input, likewise for the response, as noted by
Matan Barak[3], so it doesn't make sense to put "comp_mask" in the
header.
[1]:
http://marc.info/?i=CAL1RGDWxmM17W2o_era24A-TTDeKyoL6u3NRu_=t_dhV_ZA9MA@mail.gmail.com
[2]:
http://marc.info/?i=CAL1RGDXJtrc849M6_XNZT5xO1+ybKtLWGq6yg6LhoSsKpsmkYA@mail.gmail.com
[3]:
http://marc.info/?i=525C1149.6000701@mellanox.com
Signed-off-by: Yann Droneaud <ydroneaud@opteya.com>
Link: http://marc.info/?i=cover.1383773832.git.ydroneaud@opteya.com
[ Convert "ret ? ret : 0" to the equivalent "ret". - Roland ]
Signed-off-by: Roland Dreier <roland@purestorage.com>
2013-11-06 15:21:49 -07:00
|
|
|
struct ib_udata *ucore, \
|
|
|
|
struct ib_udata *uhw)
|
|
|
|
|
|
|
|
IB_UVERBS_DECLARE_EX_CMD(create_flow);
|
|
|
|
IB_UVERBS_DECLARE_EX_CMD(destroy_flow);
|
2015-02-08 04:28:50 -07:00
|
|
|
IB_UVERBS_DECLARE_EX_CMD(query_device);
|
2015-06-11 07:35:23 -06:00
|
|
|
IB_UVERBS_DECLARE_EX_CMD(create_cq);
|
2015-10-21 08:00:42 -06:00
|
|
|
IB_UVERBS_DECLARE_EX_CMD(create_qp);
|
2016-05-23 06:20:49 -06:00
|
|
|
IB_UVERBS_DECLARE_EX_CMD(create_wq);
|
|
|
|
IB_UVERBS_DECLARE_EX_CMD(modify_wq);
|
|
|
|
IB_UVERBS_DECLARE_EX_CMD(destroy_wq);
|
2016-05-23 06:20:52 -06:00
|
|
|
IB_UVERBS_DECLARE_EX_CMD(create_rwq_ind_table);
|
|
|
|
IB_UVERBS_DECLARE_EX_CMD(destroy_rwq_ind_table);
|
2016-12-01 04:43:15 -07:00
|
|
|
IB_UVERBS_DECLARE_EX_CMD(modify_qp);
|
IB/core: extended command: an improved infrastructure for uverbs commands
Commit 400dbc96583f ("IB/core: Infrastructure for extensible uverbs
commands") added an infrastructure for extensible uverbs commands
while later commit 436f2ad05a0b ("IB/core: Export ib_create/destroy_flow
through uverbs") exported ib_create_flow()/ib_destroy_flow() functions
using this new infrastructure.
According to the commit 400dbc96583f, the purpose of this
infrastructure is to support passing around provider (eg. hardware)
specific buffers when userspace issue commands to the kernel, so that
it would be possible to extend uverbs (eg. core) buffers independently
from the provider buffers.
But the new kernel command function prototypes were not modified to
take advantage of this extension. This issue was exposed by Roland
Dreier in a previous review[1].
So the following patch is an attempt to a revised extensible command
infrastructure.
This improved extensible command infrastructure distinguish between
core (eg. legacy)'s command/response buffers from provider
(eg. hardware)'s command/response buffers: each extended command
implementing function is given a struct ib_udata to hold core
(eg. uverbs) input and output buffers, and another struct ib_udata to
hold the hw (eg. provider) input and output buffers.
Having those buffers identified separately make it easier to increase
one buffer to support extension without having to add some code to
guess the exact size of each command/response parts: This should make
the extended functions more reliable.
Additionally, instead of relying on command identifier being greater
than IB_USER_VERBS_CMD_THRESHOLD, the proposed infrastructure rely on
unused bits in command field: on the 32 bits provided by command
field, only 6 bits are really needed to encode the identifier of
commands currently supported by the kernel. (Even using only 6 bits
leaves room for about 23 new commands).
So this patch makes use of some high order bits in command field to
store flags, leaving enough room for more command identifiers than one
will ever need (eg. 256).
The new flags are used to specify if the command should be processed
as an extended one or a legacy one. While designing the new command
format, care was taken to make usage of flags itself extensible.
Using high order bits of the commands field ensure that newer
libibverbs on older kernel will properly fail when trying to call
extended commands. On the other hand, older libibverbs on newer kernel
will never be able to issue calls to extended commands.
The extended command header includes the optional response pointer so
that output buffer length and output buffer pointer are located
together in the command, allowing proper parameters checking. This
should make implementing functions easier and safer.
Additionally the extended header ensure 64bits alignment, while making
all sizes multiple of 8 bytes, extending the maximum buffer size:
legacy extended
Maximum command buffer: 256KBytes 1024KBytes (512KBytes + 512KBytes)
Maximum response buffer: 256KBytes 1024KBytes (512KBytes + 512KBytes)
For the purpose of doing proper buffer size accounting, the headers
size are no more taken in account in "in_words".
One of the odds of the current extensible infrastructure, reading
twice the "legacy" command header, is fixed by removing the "legacy"
command header from the extended command header: they are processed as
two different parts of the command: memory is read once and
information are not duplicated: it's making clear that's an extended
command scheme and not a different command scheme.
The proposed scheme will format input (command) and output (response)
buffers this way:
- command:
legacy header +
extended header +
command data (core + hw):
+----------------------------------------+
| flags | 00 00 | command |
| in_words | out_words |
+----------------------------------------+
| response |
| response |
| provider_in_words | provider_out_words |
| padding |
+----------------------------------------+
| |
. <uverbs input> .
. (in_words * 8) .
| |
+----------------------------------------+
| |
. <provider input> .
. (provider_in_words * 8) .
| |
+----------------------------------------+
- response, if present:
+----------------------------------------+
| |
. <uverbs output space> .
. (out_words * 8) .
| |
+----------------------------------------+
| |
. <provider output space> .
. (provider_out_words * 8) .
| |
+----------------------------------------+
The overall design is to ensure that the extensible infrastructure is
itself extensible while begin more reliable with more input and bound
checking.
Note:
The unused field in the extended header would be perfect candidate to
hold the command "comp_mask" (eg. bit field used to handle
compatibility). This was suggested by Roland Dreier in a previous
review[2]. But "comp_mask" field is likely to be present in the uverb
input and/or provider input, likewise for the response, as noted by
Matan Barak[3], so it doesn't make sense to put "comp_mask" in the
header.
[1]:
http://marc.info/?i=CAL1RGDWxmM17W2o_era24A-TTDeKyoL6u3NRu_=t_dhV_ZA9MA@mail.gmail.com
[2]:
http://marc.info/?i=CAL1RGDXJtrc849M6_XNZT5xO1+ybKtLWGq6yg6LhoSsKpsmkYA@mail.gmail.com
[3]:
http://marc.info/?i=525C1149.6000701@mellanox.com
Signed-off-by: Yann Droneaud <ydroneaud@opteya.com>
Link: http://marc.info/?i=cover.1383773832.git.ydroneaud@opteya.com
[ Convert "ret ? ret : 0" to the equivalent "ret". - Roland ]
Signed-off-by: Roland Dreier <roland@purestorage.com>
2013-11-06 15:21:49 -07:00
|
|
|
|
2005-07-07 18:57:13 -06:00
|
|
|
#endif /* UVERBS_H */
|