2017-08-03 13:06:55 +00:00
|
|
|
/*
|
|
|
|
* Copyright (c) 2017, Mellanox Technologies inc. 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 _UVERBS_IOCTL_
|
|
|
|
#define _UVERBS_IOCTL_
|
|
|
|
|
|
|
|
#include <rdma/uverbs_types.h>
|
2017-08-03 13:07:01 +00:00
|
|
|
#include <linux/uaccess.h>
|
|
|
|
#include <rdma/rdma_user_ioctl.h>
|
2017-08-03 13:07:04 +00:00
|
|
|
#include <rdma/ib_user_ioctl_verbs.h>
|
2018-03-19 13:02:33 +00:00
|
|
|
#include <rdma/ib_user_ioctl_cmds.h>
|
2017-08-03 13:06:55 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* =======================================
|
|
|
|
* Verbs action specifications
|
|
|
|
* =======================================
|
|
|
|
*/
|
|
|
|
|
IB/core: Add support to finalize objects in one transaction
The new ioctl based infrastructure either commits or rollbacks
all objects of the method as one transaction. In order to do
that, we introduce a notion of dealing with a collection of
objects that are related to a specific method.
This also requires adding a notion of a method and attribute.
A method contains a hash of attributes, where each bucket
contains several attributes. The attributes are hashed according
to their namespace which resides in the four upper bits of the id.
For example, an object could be a CQ, which has an action of CREATE_CQ.
This action has multiple attributes. For example, the CQ's new handle
and the comp_channel. Each layer in this hierarchy - objects, methods
and attributes is split into namespaces. The basic example for that is
one namespace representing the default entities and another one
representing the driver specific entities.
When declaring these methods and attributes, we actually declare
their specifications. When a method is executed, we actually
allocates some space to hold auxiliary information. This auxiliary
information contains meta-data about the required objects, such
as pointers to their type information, pointers to the uobjects
themselves (if exist), etc.
The specification, along with the auxiliary information we allocated
and filled is given to the finalize_objects function.
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:56 +00:00
|
|
|
enum uverbs_attr_type {
|
|
|
|
UVERBS_ATTR_TYPE_NA,
|
IB/core: Add new ioctl interface
In this ioctl interface, processing the command starts from
properties of the command and fetching the appropriate user objects
before calling the handler.
Parsing and validation is done according to a specifier declared by
the driver's code. In the driver, all supported objects are declared.
These objects are separated to different object namepsaces. Dividing
objects to namespaces is done at initialization by using the higher
bits of the object ids. This initialization can mix objects declared
in different places to one parsing tree using in this ioctl interface.
For each object we list all supported methods. Similarly to objects,
methods are separated to method namespaces too. Namespacing is done
similarly to the objects case. This could be used in order to add
methods to an existing object.
Each method has a specific handler, which could be either a default
handler or a driver specific handler.
Along with the handler, a bunch of attributes are specified as well.
Similarly to objects and method, attributes are namespaced and hashed
by their ids at initialization too. All supported attributes are
subject to automatic fetching and validation. These attributes include
the command, response and the method's related objects' ids.
When these entities (objects, methods and attributes) are used, the
high bits of the entities ids are used in order to calculate the hash
bucket index. Then, these high bits are masked out in order to have a
zero based index. Since we use these high bits for both bucketing and
namespacing, we get a compact representation and O(1) array access.
This is mandatory for efficient dispatching.
Each attribute has a type (PTR_IN, PTR_OUT, IDR and FD) and a length.
Attributes could be validated through some attributes, like:
(*) Minimum size / Exact size
(*) Fops for FD
(*) Object type for IDR
If an IDR/fd attribute is specified, the kernel also states the object
type and the required access (NEW, WRITE, READ or DESTROY).
All uobject/fd management is done automatically by the infrastructure,
meaning - the infrastructure will fail concurrent commands that at
least one of them requires concurrent access (WRITE/DESTROY),
synchronize actions with device removals (dissociate context events)
and take care of reference counting (increase/decrease) for concurrent
actions invocation. The reference counts on the actual kernel objects
shall be handled by the handlers.
objects
+--------+
| |
| | methods +--------+
| | ns method method_spec +-----+ |len |
+--------+ +------+[d]+-------+ +----------------+[d]+------------+ |attr1+-> |type |
| object +> |method+-> | spec +-> + attr_buckets +-> |default_chain+--> +-----+ |idr_type|
+--------+ +------+ |handler| | | +------------+ |attr2| |access |
| | | | +-------+ +----------------+ |driver chain| +-----+ +--------+
| | | | +------------+
| | +------+
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
+--------+
[d] = Hash ids to groups using the high order bits
The right types table is also chosen by using the high bits from
the ids. Currently we have either default or driver specific groups.
Once validation and object fetching (or creation) completed, we call
the handler:
int (*handler)(struct ib_device *ib_dev, struct ib_uverbs_file *ufile,
struct uverbs_attr_bundle *ctx);
ctx bundles attributes of different namespaces. Each element there
is an array of attributes which corresponds to one namespaces of
attributes. For example, in the usually used case:
ctx core
+----------------------------+ +------------+
| core: +---> | valid |
+----------------------------+ | cmd_attr |
| driver: | +------------+
|----------------------------+--+ | valid |
| | cmd_attr |
| +------------+
| | valid |
| | obj_attr |
| +------------+
|
| drivers
| +------------+
+> | valid |
| cmd_attr |
+------------+
| valid |
| cmd_attr |
+------------+
| valid |
| obj_attr |
+------------+
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:57 +00:00
|
|
|
UVERBS_ATTR_TYPE_PTR_IN,
|
|
|
|
UVERBS_ATTR_TYPE_PTR_OUT,
|
IB/core: Add support to finalize objects in one transaction
The new ioctl based infrastructure either commits or rollbacks
all objects of the method as one transaction. In order to do
that, we introduce a notion of dealing with a collection of
objects that are related to a specific method.
This also requires adding a notion of a method and attribute.
A method contains a hash of attributes, where each bucket
contains several attributes. The attributes are hashed according
to their namespace which resides in the four upper bits of the id.
For example, an object could be a CQ, which has an action of CREATE_CQ.
This action has multiple attributes. For example, the CQ's new handle
and the comp_channel. Each layer in this hierarchy - objects, methods
and attributes is split into namespaces. The basic example for that is
one namespace representing the default entities and another one
representing the driver specific entities.
When declaring these methods and attributes, we actually declare
their specifications. When a method is executed, we actually
allocates some space to hold auxiliary information. This auxiliary
information contains meta-data about the required objects, such
as pointers to their type information, pointers to the uobjects
themselves (if exist), etc.
The specification, along with the auxiliary information we allocated
and filled is given to the finalize_objects function.
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:56 +00:00
|
|
|
UVERBS_ATTR_TYPE_IDR,
|
|
|
|
UVERBS_ATTR_TYPE_FD,
|
2018-03-28 06:27:42 +00:00
|
|
|
UVERBS_ATTR_TYPE_ENUM_IN,
|
IB/core: Add support to finalize objects in one transaction
The new ioctl based infrastructure either commits or rollbacks
all objects of the method as one transaction. In order to do
that, we introduce a notion of dealing with a collection of
objects that are related to a specific method.
This also requires adding a notion of a method and attribute.
A method contains a hash of attributes, where each bucket
contains several attributes. The attributes are hashed according
to their namespace which resides in the four upper bits of the id.
For example, an object could be a CQ, which has an action of CREATE_CQ.
This action has multiple attributes. For example, the CQ's new handle
and the comp_channel. Each layer in this hierarchy - objects, methods
and attributes is split into namespaces. The basic example for that is
one namespace representing the default entities and another one
representing the driver specific entities.
When declaring these methods and attributes, we actually declare
their specifications. When a method is executed, we actually
allocates some space to hold auxiliary information. This auxiliary
information contains meta-data about the required objects, such
as pointers to their type information, pointers to the uobjects
themselves (if exist), etc.
The specification, along with the auxiliary information we allocated
and filled is given to the finalize_objects function.
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:56 +00:00
|
|
|
};
|
|
|
|
|
2017-08-03 13:06:55 +00:00
|
|
|
enum uverbs_obj_access {
|
|
|
|
UVERBS_ACCESS_READ,
|
|
|
|
UVERBS_ACCESS_WRITE,
|
|
|
|
UVERBS_ACCESS_NEW,
|
|
|
|
UVERBS_ACCESS_DESTROY
|
|
|
|
};
|
|
|
|
|
2018-03-19 13:02:35 +00:00
|
|
|
/* Specification of a single attribute inside the ioctl message */
|
2018-07-04 05:50:29 +00:00
|
|
|
/* good size 16 */
|
IB/core: Add support to finalize objects in one transaction
The new ioctl based infrastructure either commits or rollbacks
all objects of the method as one transaction. In order to do
that, we introduce a notion of dealing with a collection of
objects that are related to a specific method.
This also requires adding a notion of a method and attribute.
A method contains a hash of attributes, where each bucket
contains several attributes. The attributes are hashed according
to their namespace which resides in the four upper bits of the id.
For example, an object could be a CQ, which has an action of CREATE_CQ.
This action has multiple attributes. For example, the CQ's new handle
and the comp_channel. Each layer in this hierarchy - objects, methods
and attributes is split into namespaces. The basic example for that is
one namespace representing the default entities and another one
representing the driver specific entities.
When declaring these methods and attributes, we actually declare
their specifications. When a method is executed, we actually
allocates some space to hold auxiliary information. This auxiliary
information contains meta-data about the required objects, such
as pointers to their type information, pointers to the uobjects
themselves (if exist), etc.
The specification, along with the auxiliary information we allocated
and filled is given to the finalize_objects function.
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:56 +00:00
|
|
|
struct uverbs_attr_spec {
|
2018-07-04 05:50:25 +00:00
|
|
|
u8 type;
|
2018-07-04 05:50:29 +00:00
|
|
|
|
|
|
|
/*
|
2018-07-04 05:50:31 +00:00
|
|
|
* Support extending attributes by length. Allow the user to provide
|
|
|
|
* more bytes than ptr.len, but check that everything after is zero'd
|
|
|
|
* by the user.
|
2018-07-04 05:50:29 +00:00
|
|
|
*/
|
2018-07-04 05:50:31 +00:00
|
|
|
u8 zero_trailing:1;
|
2018-07-04 05:50:29 +00:00
|
|
|
/*
|
|
|
|
* Valid only for PTR_IN. Allocate and copy the data inside
|
|
|
|
* the parser
|
|
|
|
*/
|
|
|
|
u8 alloc_and_copy:1;
|
|
|
|
u8 mandatory:1;
|
2018-07-04 05:50:25 +00:00
|
|
|
|
IB/core: Add new ioctl interface
In this ioctl interface, processing the command starts from
properties of the command and fetching the appropriate user objects
before calling the handler.
Parsing and validation is done according to a specifier declared by
the driver's code. In the driver, all supported objects are declared.
These objects are separated to different object namepsaces. Dividing
objects to namespaces is done at initialization by using the higher
bits of the object ids. This initialization can mix objects declared
in different places to one parsing tree using in this ioctl interface.
For each object we list all supported methods. Similarly to objects,
methods are separated to method namespaces too. Namespacing is done
similarly to the objects case. This could be used in order to add
methods to an existing object.
Each method has a specific handler, which could be either a default
handler or a driver specific handler.
Along with the handler, a bunch of attributes are specified as well.
Similarly to objects and method, attributes are namespaced and hashed
by their ids at initialization too. All supported attributes are
subject to automatic fetching and validation. These attributes include
the command, response and the method's related objects' ids.
When these entities (objects, methods and attributes) are used, the
high bits of the entities ids are used in order to calculate the hash
bucket index. Then, these high bits are masked out in order to have a
zero based index. Since we use these high bits for both bucketing and
namespacing, we get a compact representation and O(1) array access.
This is mandatory for efficient dispatching.
Each attribute has a type (PTR_IN, PTR_OUT, IDR and FD) and a length.
Attributes could be validated through some attributes, like:
(*) Minimum size / Exact size
(*) Fops for FD
(*) Object type for IDR
If an IDR/fd attribute is specified, the kernel also states the object
type and the required access (NEW, WRITE, READ or DESTROY).
All uobject/fd management is done automatically by the infrastructure,
meaning - the infrastructure will fail concurrent commands that at
least one of them requires concurrent access (WRITE/DESTROY),
synchronize actions with device removals (dissociate context events)
and take care of reference counting (increase/decrease) for concurrent
actions invocation. The reference counts on the actual kernel objects
shall be handled by the handlers.
objects
+--------+
| |
| | methods +--------+
| | ns method method_spec +-----+ |len |
+--------+ +------+[d]+-------+ +----------------+[d]+------------+ |attr1+-> |type |
| object +> |method+-> | spec +-> + attr_buckets +-> |default_chain+--> +-----+ |idr_type|
+--------+ +------+ |handler| | | +------------+ |attr2| |access |
| | | | +-------+ +----------------+ |driver chain| +-----+ +--------+
| | | | +------------+
| | +------+
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
+--------+
[d] = Hash ids to groups using the high order bits
The right types table is also chosen by using the high bits from
the ids. Currently we have either default or driver specific groups.
Once validation and object fetching (or creation) completed, we call
the handler:
int (*handler)(struct ib_device *ib_dev, struct ib_uverbs_file *ufile,
struct uverbs_attr_bundle *ctx);
ctx bundles attributes of different namespaces. Each element there
is an array of attributes which corresponds to one namespaces of
attributes. For example, in the usually used case:
ctx core
+----------------------------+ +------------+
| core: +---> | valid |
+----------------------------+ | cmd_attr |
| driver: | +------------+
|----------------------------+--+ | valid |
| | cmd_attr |
| +------------+
| | valid |
| | obj_attr |
| +------------+
|
| drivers
| +------------+
+> | valid |
| cmd_attr |
+------------+
| valid |
| cmd_attr |
+------------+
| valid |
| obj_attr |
+------------+
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:57 +00:00
|
|
|
union {
|
2018-03-19 13:02:35 +00:00
|
|
|
struct {
|
2018-03-19 13:02:36 +00:00
|
|
|
/* Current known size to kernel */
|
2018-07-04 05:50:25 +00:00
|
|
|
u16 len;
|
2018-03-19 13:02:36 +00:00
|
|
|
/* User isn't allowed to provide something < min_len */
|
2018-07-04 05:50:25 +00:00
|
|
|
u16 min_len;
|
2018-03-19 13:02:35 +00:00
|
|
|
} ptr;
|
2018-07-04 05:50:25 +00:00
|
|
|
|
2018-03-19 13:02:35 +00:00
|
|
|
struct {
|
IB/core: Add new ioctl interface
In this ioctl interface, processing the command starts from
properties of the command and fetching the appropriate user objects
before calling the handler.
Parsing and validation is done according to a specifier declared by
the driver's code. In the driver, all supported objects are declared.
These objects are separated to different object namepsaces. Dividing
objects to namespaces is done at initialization by using the higher
bits of the object ids. This initialization can mix objects declared
in different places to one parsing tree using in this ioctl interface.
For each object we list all supported methods. Similarly to objects,
methods are separated to method namespaces too. Namespacing is done
similarly to the objects case. This could be used in order to add
methods to an existing object.
Each method has a specific handler, which could be either a default
handler or a driver specific handler.
Along with the handler, a bunch of attributes are specified as well.
Similarly to objects and method, attributes are namespaced and hashed
by their ids at initialization too. All supported attributes are
subject to automatic fetching and validation. These attributes include
the command, response and the method's related objects' ids.
When these entities (objects, methods and attributes) are used, the
high bits of the entities ids are used in order to calculate the hash
bucket index. Then, these high bits are masked out in order to have a
zero based index. Since we use these high bits for both bucketing and
namespacing, we get a compact representation and O(1) array access.
This is mandatory for efficient dispatching.
Each attribute has a type (PTR_IN, PTR_OUT, IDR and FD) and a length.
Attributes could be validated through some attributes, like:
(*) Minimum size / Exact size
(*) Fops for FD
(*) Object type for IDR
If an IDR/fd attribute is specified, the kernel also states the object
type and the required access (NEW, WRITE, READ or DESTROY).
All uobject/fd management is done automatically by the infrastructure,
meaning - the infrastructure will fail concurrent commands that at
least one of them requires concurrent access (WRITE/DESTROY),
synchronize actions with device removals (dissociate context events)
and take care of reference counting (increase/decrease) for concurrent
actions invocation. The reference counts on the actual kernel objects
shall be handled by the handlers.
objects
+--------+
| |
| | methods +--------+
| | ns method method_spec +-----+ |len |
+--------+ +------+[d]+-------+ +----------------+[d]+------------+ |attr1+-> |type |
| object +> |method+-> | spec +-> + attr_buckets +-> |default_chain+--> +-----+ |idr_type|
+--------+ +------+ |handler| | | +------------+ |attr2| |access |
| | | | +-------+ +----------------+ |driver chain| +-----+ +--------+
| | | | +------------+
| | +------+
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
+--------+
[d] = Hash ids to groups using the high order bits
The right types table is also chosen by using the high bits from
the ids. Currently we have either default or driver specific groups.
Once validation and object fetching (or creation) completed, we call
the handler:
int (*handler)(struct ib_device *ib_dev, struct ib_uverbs_file *ufile,
struct uverbs_attr_bundle *ctx);
ctx bundles attributes of different namespaces. Each element there
is an array of attributes which corresponds to one namespaces of
attributes. For example, in the usually used case:
ctx core
+----------------------------+ +------------+
| core: +---> | valid |
+----------------------------+ | cmd_attr |
| driver: | +------------+
|----------------------------+--+ | valid |
| | cmd_attr |
| +------------+
| | valid |
| | obj_attr |
| +------------+
|
| drivers
| +------------+
+> | valid |
| cmd_attr |
+------------+
| valid |
| cmd_attr |
+------------+
| valid |
| obj_attr |
+------------+
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:57 +00:00
|
|
|
/*
|
|
|
|
* higher bits mean the namespace and lower bits mean
|
|
|
|
* the type id within the namespace.
|
|
|
|
*/
|
2018-07-04 05:50:25 +00:00
|
|
|
u16 obj_type;
|
|
|
|
u8 access;
|
IB/core: Add new ioctl interface
In this ioctl interface, processing the command starts from
properties of the command and fetching the appropriate user objects
before calling the handler.
Parsing and validation is done according to a specifier declared by
the driver's code. In the driver, all supported objects are declared.
These objects are separated to different object namepsaces. Dividing
objects to namespaces is done at initialization by using the higher
bits of the object ids. This initialization can mix objects declared
in different places to one parsing tree using in this ioctl interface.
For each object we list all supported methods. Similarly to objects,
methods are separated to method namespaces too. Namespacing is done
similarly to the objects case. This could be used in order to add
methods to an existing object.
Each method has a specific handler, which could be either a default
handler or a driver specific handler.
Along with the handler, a bunch of attributes are specified as well.
Similarly to objects and method, attributes are namespaced and hashed
by their ids at initialization too. All supported attributes are
subject to automatic fetching and validation. These attributes include
the command, response and the method's related objects' ids.
When these entities (objects, methods and attributes) are used, the
high bits of the entities ids are used in order to calculate the hash
bucket index. Then, these high bits are masked out in order to have a
zero based index. Since we use these high bits for both bucketing and
namespacing, we get a compact representation and O(1) array access.
This is mandatory for efficient dispatching.
Each attribute has a type (PTR_IN, PTR_OUT, IDR and FD) and a length.
Attributes could be validated through some attributes, like:
(*) Minimum size / Exact size
(*) Fops for FD
(*) Object type for IDR
If an IDR/fd attribute is specified, the kernel also states the object
type and the required access (NEW, WRITE, READ or DESTROY).
All uobject/fd management is done automatically by the infrastructure,
meaning - the infrastructure will fail concurrent commands that at
least one of them requires concurrent access (WRITE/DESTROY),
synchronize actions with device removals (dissociate context events)
and take care of reference counting (increase/decrease) for concurrent
actions invocation. The reference counts on the actual kernel objects
shall be handled by the handlers.
objects
+--------+
| |
| | methods +--------+
| | ns method method_spec +-----+ |len |
+--------+ +------+[d]+-------+ +----------------+[d]+------------+ |attr1+-> |type |
| object +> |method+-> | spec +-> + attr_buckets +-> |default_chain+--> +-----+ |idr_type|
+--------+ +------+ |handler| | | +------------+ |attr2| |access |
| | | | +-------+ +----------------+ |driver chain| +-----+ +--------+
| | | | +------------+
| | +------+
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
+--------+
[d] = Hash ids to groups using the high order bits
The right types table is also chosen by using the high bits from
the ids. Currently we have either default or driver specific groups.
Once validation and object fetching (or creation) completed, we call
the handler:
int (*handler)(struct ib_device *ib_dev, struct ib_uverbs_file *ufile,
struct uverbs_attr_bundle *ctx);
ctx bundles attributes of different namespaces. Each element there
is an array of attributes which corresponds to one namespaces of
attributes. For example, in the usually used case:
ctx core
+----------------------------+ +------------+
| core: +---> | valid |
+----------------------------+ | cmd_attr |
| driver: | +------------+
|----------------------------+--+ | valid |
| | cmd_attr |
| +------------+
| | valid |
| | obj_attr |
| +------------+
|
| drivers
| +------------+
+> | valid |
| cmd_attr |
+------------+
| valid |
| cmd_attr |
+------------+
| valid |
| obj_attr |
+------------+
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:57 +00:00
|
|
|
} obj;
|
2018-07-04 05:50:25 +00:00
|
|
|
|
|
|
|
struct {
|
|
|
|
u8 num_elems;
|
|
|
|
} enum_def;
|
|
|
|
} u;
|
|
|
|
|
|
|
|
/* This weird split of the enum lets us remove some padding */
|
|
|
|
union {
|
2018-03-28 06:27:42 +00:00
|
|
|
struct {
|
|
|
|
/*
|
|
|
|
* The enum attribute can select one of the attributes
|
|
|
|
* contained in the ids array. Currently only PTR_IN
|
|
|
|
* attributes are supported in the ids array.
|
|
|
|
*/
|
2018-07-04 05:50:25 +00:00
|
|
|
const struct uverbs_attr_spec *ids;
|
2018-03-28 06:27:42 +00:00
|
|
|
} enum_def;
|
2018-07-04 05:50:25 +00:00
|
|
|
} u2;
|
IB/core: Add support to finalize objects in one transaction
The new ioctl based infrastructure either commits or rollbacks
all objects of the method as one transaction. In order to do
that, we introduce a notion of dealing with a collection of
objects that are related to a specific method.
This also requires adding a notion of a method and attribute.
A method contains a hash of attributes, where each bucket
contains several attributes. The attributes are hashed according
to their namespace which resides in the four upper bits of the id.
For example, an object could be a CQ, which has an action of CREATE_CQ.
This action has multiple attributes. For example, the CQ's new handle
and the comp_channel. Each layer in this hierarchy - objects, methods
and attributes is split into namespaces. The basic example for that is
one namespace representing the default entities and another one
representing the driver specific entities.
When declaring these methods and attributes, we actually declare
their specifications. When a method is executed, we actually
allocates some space to hold auxiliary information. This auxiliary
information contains meta-data about the required objects, such
as pointers to their type information, pointers to the uobjects
themselves (if exist), etc.
The specification, along with the auxiliary information we allocated
and filled is given to the finalize_objects function.
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:56 +00:00
|
|
|
};
|
|
|
|
|
2018-08-10 02:14:36 +00:00
|
|
|
/*
|
|
|
|
* Information about the API is loaded into a radix tree. For IOCTL we start
|
|
|
|
* with a tuple of:
|
|
|
|
* object_id, attr_id, method_id
|
|
|
|
*
|
|
|
|
* Which is a 48 bit value, with most of the bits guaranteed to be zero. Based
|
|
|
|
* on the current kernel support this is compressed into 16 bit key for the
|
|
|
|
* radix tree. Since this compression is entirely internal to the kernel the
|
|
|
|
* below limits can be revised if the kernel gains additional data.
|
|
|
|
*
|
|
|
|
* With 64 leafs per node this is a 3 level radix tree.
|
|
|
|
*
|
|
|
|
* The tree encodes multiple types, and uses a scheme where OBJ_ID,0,0 returns
|
|
|
|
* the object slot, and OBJ_ID,METH_ID,0 and returns the method slot.
|
|
|
|
*/
|
|
|
|
enum uapi_radix_data {
|
|
|
|
UVERBS_API_NS_FLAG = 1U << UVERBS_ID_NS_SHIFT,
|
|
|
|
|
|
|
|
UVERBS_API_ATTR_KEY_BITS = 6,
|
|
|
|
UVERBS_API_ATTR_KEY_MASK = GENMASK(UVERBS_API_ATTR_KEY_BITS - 1, 0),
|
|
|
|
UVERBS_API_ATTR_BKEY_LEN = (1 << UVERBS_API_ATTR_KEY_BITS) - 1,
|
|
|
|
|
|
|
|
UVERBS_API_METHOD_KEY_BITS = 5,
|
|
|
|
UVERBS_API_METHOD_KEY_SHIFT = UVERBS_API_ATTR_KEY_BITS,
|
|
|
|
UVERBS_API_METHOD_KEY_NUM_CORE = 24,
|
|
|
|
UVERBS_API_METHOD_KEY_NUM_DRIVER = (1 << UVERBS_API_METHOD_KEY_BITS) -
|
|
|
|
UVERBS_API_METHOD_KEY_NUM_CORE,
|
|
|
|
UVERBS_API_METHOD_KEY_MASK = GENMASK(
|
|
|
|
UVERBS_API_METHOD_KEY_BITS + UVERBS_API_METHOD_KEY_SHIFT - 1,
|
|
|
|
UVERBS_API_METHOD_KEY_SHIFT),
|
|
|
|
|
|
|
|
UVERBS_API_OBJ_KEY_BITS = 5,
|
|
|
|
UVERBS_API_OBJ_KEY_SHIFT =
|
|
|
|
UVERBS_API_METHOD_KEY_BITS + UVERBS_API_METHOD_KEY_SHIFT,
|
|
|
|
UVERBS_API_OBJ_KEY_NUM_CORE = 24,
|
|
|
|
UVERBS_API_OBJ_KEY_NUM_DRIVER =
|
|
|
|
(1 << UVERBS_API_OBJ_KEY_BITS) - UVERBS_API_OBJ_KEY_NUM_CORE,
|
|
|
|
UVERBS_API_OBJ_KEY_MASK = GENMASK(31, UVERBS_API_OBJ_KEY_SHIFT),
|
|
|
|
|
|
|
|
/* This id guaranteed to not exist in the radix tree */
|
|
|
|
UVERBS_API_KEY_ERR = 0xFFFFFFFF,
|
|
|
|
};
|
|
|
|
|
|
|
|
static inline __attribute_const__ u32 uapi_key_obj(u32 id)
|
|
|
|
{
|
|
|
|
if (id & UVERBS_API_NS_FLAG) {
|
|
|
|
id &= ~UVERBS_API_NS_FLAG;
|
|
|
|
if (id >= UVERBS_API_OBJ_KEY_NUM_DRIVER)
|
|
|
|
return UVERBS_API_KEY_ERR;
|
|
|
|
id = id + UVERBS_API_OBJ_KEY_NUM_CORE;
|
|
|
|
} else {
|
|
|
|
if (id >= UVERBS_API_OBJ_KEY_NUM_CORE)
|
|
|
|
return UVERBS_API_KEY_ERR;
|
|
|
|
}
|
|
|
|
|
|
|
|
return id << UVERBS_API_OBJ_KEY_SHIFT;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline __attribute_const__ bool uapi_key_is_object(u32 key)
|
|
|
|
{
|
|
|
|
return (key & ~UVERBS_API_OBJ_KEY_MASK) == 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline __attribute_const__ u32 uapi_key_ioctl_method(u32 id)
|
|
|
|
{
|
|
|
|
if (id & UVERBS_API_NS_FLAG) {
|
|
|
|
id &= ~UVERBS_API_NS_FLAG;
|
|
|
|
if (id >= UVERBS_API_METHOD_KEY_NUM_DRIVER)
|
|
|
|
return UVERBS_API_KEY_ERR;
|
|
|
|
id = id + UVERBS_API_METHOD_KEY_NUM_CORE;
|
|
|
|
} else {
|
|
|
|
id++;
|
|
|
|
if (id >= UVERBS_API_METHOD_KEY_NUM_CORE)
|
|
|
|
return UVERBS_API_KEY_ERR;
|
|
|
|
}
|
|
|
|
|
|
|
|
return id << UVERBS_API_METHOD_KEY_SHIFT;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline __attribute_const__ u32 uapi_key_attr_to_method(u32 attr_key)
|
|
|
|
{
|
|
|
|
return attr_key &
|
|
|
|
(UVERBS_API_OBJ_KEY_MASK | UVERBS_API_METHOD_KEY_MASK);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline __attribute_const__ bool uapi_key_is_ioctl_method(u32 key)
|
|
|
|
{
|
|
|
|
return (key & UVERBS_API_METHOD_KEY_MASK) != 0 &&
|
|
|
|
(key & UVERBS_API_ATTR_KEY_MASK) == 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline __attribute_const__ u32 uapi_key_attrs_start(u32 ioctl_method_key)
|
|
|
|
{
|
|
|
|
/* 0 is the method slot itself */
|
|
|
|
return ioctl_method_key + 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline __attribute_const__ u32 uapi_key_attr(u32 id)
|
|
|
|
{
|
|
|
|
/*
|
|
|
|
* The attr is designed to fit in the typical single radix tree node
|
|
|
|
* of 64 entries. Since allmost all methods have driver attributes we
|
|
|
|
* organize things so that the driver and core attributes interleave to
|
|
|
|
* reduce the length of the attributes array in typical cases.
|
|
|
|
*/
|
|
|
|
if (id & UVERBS_API_NS_FLAG) {
|
|
|
|
id &= ~UVERBS_API_NS_FLAG;
|
|
|
|
id++;
|
|
|
|
if (id >= 1 << (UVERBS_API_ATTR_KEY_BITS - 1))
|
|
|
|
return UVERBS_API_KEY_ERR;
|
|
|
|
id = (id << 1) | 0;
|
|
|
|
} else {
|
|
|
|
if (id >= 1 << (UVERBS_API_ATTR_KEY_BITS - 1))
|
|
|
|
return UVERBS_API_KEY_ERR;
|
|
|
|
id = (id << 1) | 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
return id;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline __attribute_const__ bool uapi_key_is_attr(u32 key)
|
|
|
|
{
|
|
|
|
return (key & UVERBS_API_METHOD_KEY_MASK) != 0 &&
|
|
|
|
(key & UVERBS_API_ATTR_KEY_MASK) != 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This returns a value in the range [0 to UVERBS_API_ATTR_BKEY_LEN),
|
|
|
|
* basically it undoes the reservation of 0 in the ID numbering. attr_key
|
|
|
|
* must already be masked with UVERBS_API_ATTR_KEY_MASK, or be the output of
|
|
|
|
* uapi_key_attr().
|
|
|
|
*/
|
|
|
|
static inline __attribute_const__ u32 uapi_bkey_attr(u32 attr_key)
|
|
|
|
{
|
|
|
|
return attr_key - 1;
|
|
|
|
}
|
|
|
|
|
2017-08-03 13:06:58 +00:00
|
|
|
/*
|
|
|
|
* =======================================
|
|
|
|
* Verbs definitions
|
|
|
|
* =======================================
|
|
|
|
*/
|
|
|
|
|
2017-08-03 13:06:59 +00:00
|
|
|
struct uverbs_attr_def {
|
|
|
|
u16 id;
|
|
|
|
struct uverbs_attr_spec attr;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct uverbs_method_def {
|
|
|
|
u16 id;
|
|
|
|
/* Combination of bits from enum UVERBS_ACTION_FLAG_XXXX */
|
|
|
|
u32 flags;
|
|
|
|
size_t num_attrs;
|
|
|
|
const struct uverbs_attr_def * const (*attrs)[];
|
2018-07-26 03:40:18 +00:00
|
|
|
int (*handler)(struct ib_uverbs_file *ufile,
|
2017-08-03 13:06:59 +00:00
|
|
|
struct uverbs_attr_bundle *ctx);
|
|
|
|
};
|
|
|
|
|
2017-08-03 13:06:58 +00:00
|
|
|
struct uverbs_object_def {
|
2017-08-03 13:06:59 +00:00
|
|
|
u16 id;
|
2017-08-03 13:06:58 +00:00
|
|
|
const struct uverbs_obj_type *type_attrs;
|
2017-08-03 13:06:59 +00:00
|
|
|
size_t num_methods;
|
|
|
|
const struct uverbs_method_def * const (*methods)[];
|
|
|
|
};
|
|
|
|
|
|
|
|
struct uverbs_object_tree_def {
|
|
|
|
size_t num_objects;
|
|
|
|
const struct uverbs_object_def * const (*objects)[];
|
2017-08-03 13:06:58 +00:00
|
|
|
};
|
|
|
|
|
2018-07-04 05:50:25 +00:00
|
|
|
/*
|
|
|
|
* =======================================
|
|
|
|
* Attribute Specifications
|
|
|
|
* =======================================
|
|
|
|
*/
|
2018-03-19 13:02:36 +00:00
|
|
|
|
|
|
|
#define UVERBS_ATTR_SIZE(_min_len, _len) \
|
2018-07-04 05:50:25 +00:00
|
|
|
.u.ptr.min_len = _min_len, .u.ptr.len = _len
|
2018-07-04 05:50:31 +00:00
|
|
|
|
2018-07-23 12:25:07 +00:00
|
|
|
#define UVERBS_ATTR_NO_DATA() UVERBS_ATTR_SIZE(0, 0)
|
|
|
|
|
2018-07-04 05:50:31 +00:00
|
|
|
/*
|
|
|
|
* Specifies a uapi structure that cannot be extended. The user must always
|
|
|
|
* supply the whole structure and nothing more. The structure must be declared
|
|
|
|
* in a header under include/uapi/rdma.
|
|
|
|
*/
|
|
|
|
#define UVERBS_ATTR_TYPE(_type) \
|
|
|
|
.u.ptr.min_len = sizeof(_type), .u.ptr.len = sizeof(_type)
|
|
|
|
/*
|
|
|
|
* Specifies a uapi structure where the user must provide at least up to
|
|
|
|
* member 'last'. Anything after last and up until the end of the structure
|
|
|
|
* can be non-zero, anything longer than the end of the structure must be
|
|
|
|
* zero. The structure must be declared in a header under include/uapi/rdma.
|
|
|
|
*/
|
|
|
|
#define UVERBS_ATTR_STRUCT(_type, _last) \
|
|
|
|
.zero_trailing = 1, \
|
|
|
|
UVERBS_ATTR_SIZE(((uintptr_t)(&((_type *)0)->_last + 1)), \
|
|
|
|
sizeof(_type))
|
2018-07-04 05:50:30 +00:00
|
|
|
/*
|
|
|
|
* Specifies at least min_len bytes must be passed in, but the amount can be
|
|
|
|
* larger, up to the protocol maximum size. No check for zeroing is done.
|
|
|
|
*/
|
|
|
|
#define UVERBS_ATTR_MIN_SIZE(_min_len) UVERBS_ATTR_SIZE(_min_len, USHRT_MAX)
|
2018-03-19 13:02:36 +00:00
|
|
|
|
2018-07-04 05:50:25 +00:00
|
|
|
/* Must be used in the '...' of any UVERBS_ATTR */
|
2018-07-04 05:50:29 +00:00
|
|
|
#define UA_ALLOC_AND_COPY .alloc_and_copy = 1
|
|
|
|
#define UA_MANDATORY .mandatory = 1
|
|
|
|
#define UA_OPTIONAL .mandatory = 0
|
2018-07-04 05:50:25 +00:00
|
|
|
|
|
|
|
#define UVERBS_ATTR_IDR(_attr_id, _idr_type, _access, ...) \
|
2018-07-04 05:50:28 +00:00
|
|
|
(&(const struct uverbs_attr_def){ \
|
2018-07-04 05:50:25 +00:00
|
|
|
.id = _attr_id, \
|
|
|
|
.attr = { .type = UVERBS_ATTR_TYPE_IDR, \
|
|
|
|
.u.obj.obj_type = _idr_type, \
|
|
|
|
.u.obj.access = _access, \
|
|
|
|
__VA_ARGS__ } })
|
|
|
|
|
|
|
|
#define UVERBS_ATTR_FD(_attr_id, _fd_type, _access, ...) \
|
2018-07-04 05:50:28 +00:00
|
|
|
(&(const struct uverbs_attr_def){ \
|
2018-07-04 05:50:25 +00:00
|
|
|
.id = (_attr_id) + \
|
|
|
|
BUILD_BUG_ON_ZERO((_access) != UVERBS_ACCESS_NEW && \
|
|
|
|
(_access) != UVERBS_ACCESS_READ), \
|
|
|
|
.attr = { .type = UVERBS_ATTR_TYPE_FD, \
|
|
|
|
.u.obj.obj_type = _fd_type, \
|
|
|
|
.u.obj.access = _access, \
|
|
|
|
__VA_ARGS__ } })
|
|
|
|
|
|
|
|
#define UVERBS_ATTR_PTR_IN(_attr_id, _type, ...) \
|
2018-07-04 05:50:28 +00:00
|
|
|
(&(const struct uverbs_attr_def){ \
|
2018-07-04 05:50:25 +00:00
|
|
|
.id = _attr_id, \
|
|
|
|
.attr = { .type = UVERBS_ATTR_TYPE_PTR_IN, \
|
|
|
|
_type, \
|
|
|
|
__VA_ARGS__ } })
|
|
|
|
|
|
|
|
#define UVERBS_ATTR_PTR_OUT(_attr_id, _type, ...) \
|
2018-07-04 05:50:28 +00:00
|
|
|
(&(const struct uverbs_attr_def){ \
|
2018-07-04 05:50:25 +00:00
|
|
|
.id = _attr_id, \
|
|
|
|
.attr = { .type = UVERBS_ATTR_TYPE_PTR_OUT, \
|
|
|
|
_type, \
|
|
|
|
__VA_ARGS__ } })
|
|
|
|
|
|
|
|
/* _enum_arry should be a 'static const union uverbs_attr_spec[]' */
|
|
|
|
#define UVERBS_ATTR_ENUM_IN(_attr_id, _enum_arr, ...) \
|
2018-07-04 05:50:28 +00:00
|
|
|
(&(const struct uverbs_attr_def){ \
|
2018-07-04 05:50:25 +00:00
|
|
|
.id = _attr_id, \
|
|
|
|
.attr = { .type = UVERBS_ATTR_TYPE_ENUM_IN, \
|
|
|
|
.u2.enum_def.ids = _enum_arr, \
|
|
|
|
.u.enum_def.num_elems = ARRAY_SIZE(_enum_arr), \
|
|
|
|
__VA_ARGS__ }, \
|
|
|
|
})
|
2017-08-03 13:07:01 +00:00
|
|
|
|
2018-07-26 22:37:14 +00:00
|
|
|
/*
|
|
|
|
* An input value that is a bitwise combination of values of _enum_type.
|
|
|
|
* This permits the flag value to be passed as either a u32 or u64, it must
|
|
|
|
* be retrieved via uverbs_get_flag().
|
|
|
|
*/
|
|
|
|
#define UVERBS_ATTR_FLAGS_IN(_attr_id, _enum_type, ...) \
|
|
|
|
UVERBS_ATTR_PTR_IN( \
|
|
|
|
_attr_id, \
|
|
|
|
UVERBS_ATTR_SIZE(sizeof(u32) + BUILD_BUG_ON_ZERO( \
|
|
|
|
!sizeof(_enum_type *)), \
|
|
|
|
sizeof(u64)), \
|
|
|
|
__VA_ARGS__)
|
|
|
|
|
2018-07-04 05:50:27 +00:00
|
|
|
/*
|
|
|
|
* This spec is used in order to pass information to the hardware driver in a
|
|
|
|
* legacy way. Every verb that could get driver specific data should get this
|
|
|
|
* spec.
|
|
|
|
*/
|
|
|
|
#define UVERBS_ATTR_UHW() \
|
2018-07-04 05:50:28 +00:00
|
|
|
UVERBS_ATTR_PTR_IN(UVERBS_ATTR_UHW_IN, \
|
2018-07-04 05:50:30 +00:00
|
|
|
UVERBS_ATTR_MIN_SIZE(0), \
|
|
|
|
UA_OPTIONAL), \
|
2018-07-04 05:50:28 +00:00
|
|
|
UVERBS_ATTR_PTR_OUT(UVERBS_ATTR_UHW_OUT, \
|
2018-07-04 05:50:30 +00:00
|
|
|
UVERBS_ATTR_MIN_SIZE(0), \
|
|
|
|
UA_OPTIONAL)
|
2018-07-04 05:50:27 +00:00
|
|
|
|
2017-08-03 13:07:01 +00:00
|
|
|
/*
|
2018-07-04 05:50:25 +00:00
|
|
|
* =======================================
|
|
|
|
* Declaration helpers
|
|
|
|
* =======================================
|
2017-08-03 13:07:01 +00:00
|
|
|
*/
|
2018-07-04 05:50:27 +00:00
|
|
|
|
|
|
|
#define DECLARE_UVERBS_OBJECT_TREE(_name, ...) \
|
|
|
|
static const struct uverbs_object_def *const _name##_ptr[] = { \
|
|
|
|
__VA_ARGS__, \
|
|
|
|
}; \
|
|
|
|
static const struct uverbs_object_tree_def _name = { \
|
|
|
|
.num_objects = ARRAY_SIZE(_name##_ptr), \
|
|
|
|
.objects = &_name##_ptr, \
|
|
|
|
}
|
2017-08-03 13:06:59 +00:00
|
|
|
|
IB/core: Add new ioctl interface
In this ioctl interface, processing the command starts from
properties of the command and fetching the appropriate user objects
before calling the handler.
Parsing and validation is done according to a specifier declared by
the driver's code. In the driver, all supported objects are declared.
These objects are separated to different object namepsaces. Dividing
objects to namespaces is done at initialization by using the higher
bits of the object ids. This initialization can mix objects declared
in different places to one parsing tree using in this ioctl interface.
For each object we list all supported methods. Similarly to objects,
methods are separated to method namespaces too. Namespacing is done
similarly to the objects case. This could be used in order to add
methods to an existing object.
Each method has a specific handler, which could be either a default
handler or a driver specific handler.
Along with the handler, a bunch of attributes are specified as well.
Similarly to objects and method, attributes are namespaced and hashed
by their ids at initialization too. All supported attributes are
subject to automatic fetching and validation. These attributes include
the command, response and the method's related objects' ids.
When these entities (objects, methods and attributes) are used, the
high bits of the entities ids are used in order to calculate the hash
bucket index. Then, these high bits are masked out in order to have a
zero based index. Since we use these high bits for both bucketing and
namespacing, we get a compact representation and O(1) array access.
This is mandatory for efficient dispatching.
Each attribute has a type (PTR_IN, PTR_OUT, IDR and FD) and a length.
Attributes could be validated through some attributes, like:
(*) Minimum size / Exact size
(*) Fops for FD
(*) Object type for IDR
If an IDR/fd attribute is specified, the kernel also states the object
type and the required access (NEW, WRITE, READ or DESTROY).
All uobject/fd management is done automatically by the infrastructure,
meaning - the infrastructure will fail concurrent commands that at
least one of them requires concurrent access (WRITE/DESTROY),
synchronize actions with device removals (dissociate context events)
and take care of reference counting (increase/decrease) for concurrent
actions invocation. The reference counts on the actual kernel objects
shall be handled by the handlers.
objects
+--------+
| |
| | methods +--------+
| | ns method method_spec +-----+ |len |
+--------+ +------+[d]+-------+ +----------------+[d]+------------+ |attr1+-> |type |
| object +> |method+-> | spec +-> + attr_buckets +-> |default_chain+--> +-----+ |idr_type|
+--------+ +------+ |handler| | | +------------+ |attr2| |access |
| | | | +-------+ +----------------+ |driver chain| +-----+ +--------+
| | | | +------------+
| | +------+
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
+--------+
[d] = Hash ids to groups using the high order bits
The right types table is also chosen by using the high bits from
the ids. Currently we have either default or driver specific groups.
Once validation and object fetching (or creation) completed, we call
the handler:
int (*handler)(struct ib_device *ib_dev, struct ib_uverbs_file *ufile,
struct uverbs_attr_bundle *ctx);
ctx bundles attributes of different namespaces. Each element there
is an array of attributes which corresponds to one namespaces of
attributes. For example, in the usually used case:
ctx core
+----------------------------+ +------------+
| core: +---> | valid |
+----------------------------+ | cmd_attr |
| driver: | +------------+
|----------------------------+--+ | valid |
| | cmd_attr |
| +------------+
| | valid |
| | obj_attr |
| +------------+
|
| drivers
| +------------+
+> | valid |
| cmd_attr |
+------------+
| valid |
| cmd_attr |
+------------+
| valid |
| obj_attr |
+------------+
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:57 +00:00
|
|
|
/* =================================================
|
|
|
|
* Parsing infrastructure
|
|
|
|
* =================================================
|
|
|
|
*/
|
|
|
|
|
2018-08-10 02:14:42 +00:00
|
|
|
|
IB/core: Add new ioctl interface
In this ioctl interface, processing the command starts from
properties of the command and fetching the appropriate user objects
before calling the handler.
Parsing and validation is done according to a specifier declared by
the driver's code. In the driver, all supported objects are declared.
These objects are separated to different object namepsaces. Dividing
objects to namespaces is done at initialization by using the higher
bits of the object ids. This initialization can mix objects declared
in different places to one parsing tree using in this ioctl interface.
For each object we list all supported methods. Similarly to objects,
methods are separated to method namespaces too. Namespacing is done
similarly to the objects case. This could be used in order to add
methods to an existing object.
Each method has a specific handler, which could be either a default
handler or a driver specific handler.
Along with the handler, a bunch of attributes are specified as well.
Similarly to objects and method, attributes are namespaced and hashed
by their ids at initialization too. All supported attributes are
subject to automatic fetching and validation. These attributes include
the command, response and the method's related objects' ids.
When these entities (objects, methods and attributes) are used, the
high bits of the entities ids are used in order to calculate the hash
bucket index. Then, these high bits are masked out in order to have a
zero based index. Since we use these high bits for both bucketing and
namespacing, we get a compact representation and O(1) array access.
This is mandatory for efficient dispatching.
Each attribute has a type (PTR_IN, PTR_OUT, IDR and FD) and a length.
Attributes could be validated through some attributes, like:
(*) Minimum size / Exact size
(*) Fops for FD
(*) Object type for IDR
If an IDR/fd attribute is specified, the kernel also states the object
type and the required access (NEW, WRITE, READ or DESTROY).
All uobject/fd management is done automatically by the infrastructure,
meaning - the infrastructure will fail concurrent commands that at
least one of them requires concurrent access (WRITE/DESTROY),
synchronize actions with device removals (dissociate context events)
and take care of reference counting (increase/decrease) for concurrent
actions invocation. The reference counts on the actual kernel objects
shall be handled by the handlers.
objects
+--------+
| |
| | methods +--------+
| | ns method method_spec +-----+ |len |
+--------+ +------+[d]+-------+ +----------------+[d]+------------+ |attr1+-> |type |
| object +> |method+-> | spec +-> + attr_buckets +-> |default_chain+--> +-----+ |idr_type|
+--------+ +------+ |handler| | | +------------+ |attr2| |access |
| | | | +-------+ +----------------+ |driver chain| +-----+ +--------+
| | | | +------------+
| | +------+
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
+--------+
[d] = Hash ids to groups using the high order bits
The right types table is also chosen by using the high bits from
the ids. Currently we have either default or driver specific groups.
Once validation and object fetching (or creation) completed, we call
the handler:
int (*handler)(struct ib_device *ib_dev, struct ib_uverbs_file *ufile,
struct uverbs_attr_bundle *ctx);
ctx bundles attributes of different namespaces. Each element there
is an array of attributes which corresponds to one namespaces of
attributes. For example, in the usually used case:
ctx core
+----------------------------+ +------------+
| core: +---> | valid |
+----------------------------+ | cmd_attr |
| driver: | +------------+
|----------------------------+--+ | valid |
| | cmd_attr |
| +------------+
| | valid |
| | obj_attr |
| +------------+
|
| drivers
| +------------+
+> | valid |
| cmd_attr |
+------------+
| valid |
| cmd_attr |
+------------+
| valid |
| obj_attr |
+------------+
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:57 +00:00
|
|
|
struct uverbs_ptr_attr {
|
2018-06-17 09:59:52 +00:00
|
|
|
/*
|
|
|
|
* If UVERBS_ATTR_SPEC_F_ALLOC_AND_COPY is set then the 'ptr' is
|
|
|
|
* used.
|
|
|
|
*/
|
|
|
|
union {
|
|
|
|
void *ptr;
|
|
|
|
u64 data;
|
|
|
|
};
|
IB/core: Add new ioctl interface
In this ioctl interface, processing the command starts from
properties of the command and fetching the appropriate user objects
before calling the handler.
Parsing and validation is done according to a specifier declared by
the driver's code. In the driver, all supported objects are declared.
These objects are separated to different object namepsaces. Dividing
objects to namespaces is done at initialization by using the higher
bits of the object ids. This initialization can mix objects declared
in different places to one parsing tree using in this ioctl interface.
For each object we list all supported methods. Similarly to objects,
methods are separated to method namespaces too. Namespacing is done
similarly to the objects case. This could be used in order to add
methods to an existing object.
Each method has a specific handler, which could be either a default
handler or a driver specific handler.
Along with the handler, a bunch of attributes are specified as well.
Similarly to objects and method, attributes are namespaced and hashed
by their ids at initialization too. All supported attributes are
subject to automatic fetching and validation. These attributes include
the command, response and the method's related objects' ids.
When these entities (objects, methods and attributes) are used, the
high bits of the entities ids are used in order to calculate the hash
bucket index. Then, these high bits are masked out in order to have a
zero based index. Since we use these high bits for both bucketing and
namespacing, we get a compact representation and O(1) array access.
This is mandatory for efficient dispatching.
Each attribute has a type (PTR_IN, PTR_OUT, IDR and FD) and a length.
Attributes could be validated through some attributes, like:
(*) Minimum size / Exact size
(*) Fops for FD
(*) Object type for IDR
If an IDR/fd attribute is specified, the kernel also states the object
type and the required access (NEW, WRITE, READ or DESTROY).
All uobject/fd management is done automatically by the infrastructure,
meaning - the infrastructure will fail concurrent commands that at
least one of them requires concurrent access (WRITE/DESTROY),
synchronize actions with device removals (dissociate context events)
and take care of reference counting (increase/decrease) for concurrent
actions invocation. The reference counts on the actual kernel objects
shall be handled by the handlers.
objects
+--------+
| |
| | methods +--------+
| | ns method method_spec +-----+ |len |
+--------+ +------+[d]+-------+ +----------------+[d]+------------+ |attr1+-> |type |
| object +> |method+-> | spec +-> + attr_buckets +-> |default_chain+--> +-----+ |idr_type|
+--------+ +------+ |handler| | | +------------+ |attr2| |access |
| | | | +-------+ +----------------+ |driver chain| +-----+ +--------+
| | | | +------------+
| | +------+
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
+--------+
[d] = Hash ids to groups using the high order bits
The right types table is also chosen by using the high bits from
the ids. Currently we have either default or driver specific groups.
Once validation and object fetching (or creation) completed, we call
the handler:
int (*handler)(struct ib_device *ib_dev, struct ib_uverbs_file *ufile,
struct uverbs_attr_bundle *ctx);
ctx bundles attributes of different namespaces. Each element there
is an array of attributes which corresponds to one namespaces of
attributes. For example, in the usually used case:
ctx core
+----------------------------+ +------------+
| core: +---> | valid |
+----------------------------+ | cmd_attr |
| driver: | +------------+
|----------------------------+--+ | valid |
| | cmd_attr |
| +------------+
| | valid |
| | obj_attr |
| +------------+
|
| drivers
| +------------+
+> | valid |
| cmd_attr |
+------------+
| valid |
| cmd_attr |
+------------+
| valid |
| obj_attr |
+------------+
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:57 +00:00
|
|
|
u16 len;
|
2018-08-10 02:14:39 +00:00
|
|
|
u16 uattr_idx;
|
2018-03-28 06:27:42 +00:00
|
|
|
u8 enum_id;
|
IB/core: Add new ioctl interface
In this ioctl interface, processing the command starts from
properties of the command and fetching the appropriate user objects
before calling the handler.
Parsing and validation is done according to a specifier declared by
the driver's code. In the driver, all supported objects are declared.
These objects are separated to different object namepsaces. Dividing
objects to namespaces is done at initialization by using the higher
bits of the object ids. This initialization can mix objects declared
in different places to one parsing tree using in this ioctl interface.
For each object we list all supported methods. Similarly to objects,
methods are separated to method namespaces too. Namespacing is done
similarly to the objects case. This could be used in order to add
methods to an existing object.
Each method has a specific handler, which could be either a default
handler or a driver specific handler.
Along with the handler, a bunch of attributes are specified as well.
Similarly to objects and method, attributes are namespaced and hashed
by their ids at initialization too. All supported attributes are
subject to automatic fetching and validation. These attributes include
the command, response and the method's related objects' ids.
When these entities (objects, methods and attributes) are used, the
high bits of the entities ids are used in order to calculate the hash
bucket index. Then, these high bits are masked out in order to have a
zero based index. Since we use these high bits for both bucketing and
namespacing, we get a compact representation and O(1) array access.
This is mandatory for efficient dispatching.
Each attribute has a type (PTR_IN, PTR_OUT, IDR and FD) and a length.
Attributes could be validated through some attributes, like:
(*) Minimum size / Exact size
(*) Fops for FD
(*) Object type for IDR
If an IDR/fd attribute is specified, the kernel also states the object
type and the required access (NEW, WRITE, READ or DESTROY).
All uobject/fd management is done automatically by the infrastructure,
meaning - the infrastructure will fail concurrent commands that at
least one of them requires concurrent access (WRITE/DESTROY),
synchronize actions with device removals (dissociate context events)
and take care of reference counting (increase/decrease) for concurrent
actions invocation. The reference counts on the actual kernel objects
shall be handled by the handlers.
objects
+--------+
| |
| | methods +--------+
| | ns method method_spec +-----+ |len |
+--------+ +------+[d]+-------+ +----------------+[d]+------------+ |attr1+-> |type |
| object +> |method+-> | spec +-> + attr_buckets +-> |default_chain+--> +-----+ |idr_type|
+--------+ +------+ |handler| | | +------------+ |attr2| |access |
| | | | +-------+ +----------------+ |driver chain| +-----+ +--------+
| | | | +------------+
| | +------+
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
+--------+
[d] = Hash ids to groups using the high order bits
The right types table is also chosen by using the high bits from
the ids. Currently we have either default or driver specific groups.
Once validation and object fetching (or creation) completed, we call
the handler:
int (*handler)(struct ib_device *ib_dev, struct ib_uverbs_file *ufile,
struct uverbs_attr_bundle *ctx);
ctx bundles attributes of different namespaces. Each element there
is an array of attributes which corresponds to one namespaces of
attributes. For example, in the usually used case:
ctx core
+----------------------------+ +------------+
| core: +---> | valid |
+----------------------------+ | cmd_attr |
| driver: | +------------+
|----------------------------+--+ | valid |
| | cmd_attr |
| +------------+
| | valid |
| | obj_attr |
| +------------+
|
| drivers
| +------------+
+> | valid |
| cmd_attr |
+------------+
| valid |
| cmd_attr |
+------------+
| valid |
| obj_attr |
+------------+
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:57 +00:00
|
|
|
};
|
|
|
|
|
IB/core: Add support to finalize objects in one transaction
The new ioctl based infrastructure either commits or rollbacks
all objects of the method as one transaction. In order to do
that, we introduce a notion of dealing with a collection of
objects that are related to a specific method.
This also requires adding a notion of a method and attribute.
A method contains a hash of attributes, where each bucket
contains several attributes. The attributes are hashed according
to their namespace which resides in the four upper bits of the id.
For example, an object could be a CQ, which has an action of CREATE_CQ.
This action has multiple attributes. For example, the CQ's new handle
and the comp_channel. Each layer in this hierarchy - objects, methods
and attributes is split into namespaces. The basic example for that is
one namespace representing the default entities and another one
representing the driver specific entities.
When declaring these methods and attributes, we actually declare
their specifications. When a method is executed, we actually
allocates some space to hold auxiliary information. This auxiliary
information contains meta-data about the required objects, such
as pointers to their type information, pointers to the uobjects
themselves (if exist), etc.
The specification, along with the auxiliary information we allocated
and filled is given to the finalize_objects function.
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:56 +00:00
|
|
|
struct uverbs_obj_attr {
|
|
|
|
struct ib_uobject *uobject;
|
2018-08-10 02:14:42 +00:00
|
|
|
const struct uverbs_api_attr *attr_elm;
|
IB/core: Add support to finalize objects in one transaction
The new ioctl based infrastructure either commits or rollbacks
all objects of the method as one transaction. In order to do
that, we introduce a notion of dealing with a collection of
objects that are related to a specific method.
This also requires adding a notion of a method and attribute.
A method contains a hash of attributes, where each bucket
contains several attributes. The attributes are hashed according
to their namespace which resides in the four upper bits of the id.
For example, an object could be a CQ, which has an action of CREATE_CQ.
This action has multiple attributes. For example, the CQ's new handle
and the comp_channel. Each layer in this hierarchy - objects, methods
and attributes is split into namespaces. The basic example for that is
one namespace representing the default entities and another one
representing the driver specific entities.
When declaring these methods and attributes, we actually declare
their specifications. When a method is executed, we actually
allocates some space to hold auxiliary information. This auxiliary
information contains meta-data about the required objects, such
as pointers to their type information, pointers to the uobjects
themselves (if exist), etc.
The specification, along with the auxiliary information we allocated
and filled is given to the finalize_objects function.
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:56 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct uverbs_attr {
|
IB/core: Add new ioctl interface
In this ioctl interface, processing the command starts from
properties of the command and fetching the appropriate user objects
before calling the handler.
Parsing and validation is done according to a specifier declared by
the driver's code. In the driver, all supported objects are declared.
These objects are separated to different object namepsaces. Dividing
objects to namespaces is done at initialization by using the higher
bits of the object ids. This initialization can mix objects declared
in different places to one parsing tree using in this ioctl interface.
For each object we list all supported methods. Similarly to objects,
methods are separated to method namespaces too. Namespacing is done
similarly to the objects case. This could be used in order to add
methods to an existing object.
Each method has a specific handler, which could be either a default
handler or a driver specific handler.
Along with the handler, a bunch of attributes are specified as well.
Similarly to objects and method, attributes are namespaced and hashed
by their ids at initialization too. All supported attributes are
subject to automatic fetching and validation. These attributes include
the command, response and the method's related objects' ids.
When these entities (objects, methods and attributes) are used, the
high bits of the entities ids are used in order to calculate the hash
bucket index. Then, these high bits are masked out in order to have a
zero based index. Since we use these high bits for both bucketing and
namespacing, we get a compact representation and O(1) array access.
This is mandatory for efficient dispatching.
Each attribute has a type (PTR_IN, PTR_OUT, IDR and FD) and a length.
Attributes could be validated through some attributes, like:
(*) Minimum size / Exact size
(*) Fops for FD
(*) Object type for IDR
If an IDR/fd attribute is specified, the kernel also states the object
type and the required access (NEW, WRITE, READ or DESTROY).
All uobject/fd management is done automatically by the infrastructure,
meaning - the infrastructure will fail concurrent commands that at
least one of them requires concurrent access (WRITE/DESTROY),
synchronize actions with device removals (dissociate context events)
and take care of reference counting (increase/decrease) for concurrent
actions invocation. The reference counts on the actual kernel objects
shall be handled by the handlers.
objects
+--------+
| |
| | methods +--------+
| | ns method method_spec +-----+ |len |
+--------+ +------+[d]+-------+ +----------------+[d]+------------+ |attr1+-> |type |
| object +> |method+-> | spec +-> + attr_buckets +-> |default_chain+--> +-----+ |idr_type|
+--------+ +------+ |handler| | | +------------+ |attr2| |access |
| | | | +-------+ +----------------+ |driver chain| +-----+ +--------+
| | | | +------------+
| | +------+
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
+--------+
[d] = Hash ids to groups using the high order bits
The right types table is also chosen by using the high bits from
the ids. Currently we have either default or driver specific groups.
Once validation and object fetching (or creation) completed, we call
the handler:
int (*handler)(struct ib_device *ib_dev, struct ib_uverbs_file *ufile,
struct uverbs_attr_bundle *ctx);
ctx bundles attributes of different namespaces. Each element there
is an array of attributes which corresponds to one namespaces of
attributes. For example, in the usually used case:
ctx core
+----------------------------+ +------------+
| core: +---> | valid |
+----------------------------+ | cmd_attr |
| driver: | +------------+
|----------------------------+--+ | valid |
| | cmd_attr |
| +------------+
| | valid |
| | obj_attr |
| +------------+
|
| drivers
| +------------+
+> | valid |
| cmd_attr |
+------------+
| valid |
| cmd_attr |
+------------+
| valid |
| obj_attr |
+------------+
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:57 +00:00
|
|
|
union {
|
|
|
|
struct uverbs_ptr_attr ptr_attr;
|
|
|
|
struct uverbs_obj_attr obj_attr;
|
|
|
|
};
|
IB/core: Add support to finalize objects in one transaction
The new ioctl based infrastructure either commits or rollbacks
all objects of the method as one transaction. In order to do
that, we introduce a notion of dealing with a collection of
objects that are related to a specific method.
This also requires adding a notion of a method and attribute.
A method contains a hash of attributes, where each bucket
contains several attributes. The attributes are hashed according
to their namespace which resides in the four upper bits of the id.
For example, an object could be a CQ, which has an action of CREATE_CQ.
This action has multiple attributes. For example, the CQ's new handle
and the comp_channel. Each layer in this hierarchy - objects, methods
and attributes is split into namespaces. The basic example for that is
one namespace representing the default entities and another one
representing the driver specific entities.
When declaring these methods and attributes, we actually declare
their specifications. When a method is executed, we actually
allocates some space to hold auxiliary information. This auxiliary
information contains meta-data about the required objects, such
as pointers to their type information, pointers to the uobjects
themselves (if exist), etc.
The specification, along with the auxiliary information we allocated
and filled is given to the finalize_objects function.
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:56 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct uverbs_attr_bundle {
|
2018-08-10 02:14:38 +00:00
|
|
|
struct ib_uverbs_file *ufile;
|
2018-08-10 02:14:42 +00:00
|
|
|
DECLARE_BITMAP(attr_present, UVERBS_API_ATTR_BKEY_LEN);
|
|
|
|
struct uverbs_attr attrs[];
|
IB/core: Add support to finalize objects in one transaction
The new ioctl based infrastructure either commits or rollbacks
all objects of the method as one transaction. In order to do
that, we introduce a notion of dealing with a collection of
objects that are related to a specific method.
This also requires adding a notion of a method and attribute.
A method contains a hash of attributes, where each bucket
contains several attributes. The attributes are hashed according
to their namespace which resides in the four upper bits of the id.
For example, an object could be a CQ, which has an action of CREATE_CQ.
This action has multiple attributes. For example, the CQ's new handle
and the comp_channel. Each layer in this hierarchy - objects, methods
and attributes is split into namespaces. The basic example for that is
one namespace representing the default entities and another one
representing the driver specific entities.
When declaring these methods and attributes, we actually declare
their specifications. When a method is executed, we actually
allocates some space to hold auxiliary information. This auxiliary
information contains meta-data about the required objects, such
as pointers to their type information, pointers to the uobjects
themselves (if exist), etc.
The specification, along with the auxiliary information we allocated
and filled is given to the finalize_objects function.
Signed-off-by: Matan Barak <matanb@mellanox.com>
Reviewed-by: Yishai Hadas <yishaih@mellanox.com>
Signed-off-by: Doug Ledford <dledford@redhat.com>
2017-08-03 13:06:56 +00:00
|
|
|
};
|
|
|
|
|
2017-08-03 13:07:01 +00:00
|
|
|
static inline bool uverbs_attr_is_valid(const struct uverbs_attr_bundle *attrs_bundle,
|
|
|
|
unsigned int idx)
|
|
|
|
{
|
2018-08-10 02:14:42 +00:00
|
|
|
return test_bit(uapi_bkey_attr(uapi_key_attr(idx)),
|
|
|
|
attrs_bundle->attr_present);
|
2017-08-03 13:07:01 +00:00
|
|
|
}
|
|
|
|
|
2018-03-19 13:02:38 +00:00
|
|
|
#define IS_UVERBS_COPY_ERR(_ret) ((_ret) && (_ret) != -ENOENT)
|
|
|
|
|
2017-08-03 13:07:04 +00:00
|
|
|
static inline const struct uverbs_attr *uverbs_attr_get(const struct uverbs_attr_bundle *attrs_bundle,
|
|
|
|
u16 idx)
|
|
|
|
{
|
|
|
|
if (!uverbs_attr_is_valid(attrs_bundle, idx))
|
|
|
|
return ERR_PTR(-ENOENT);
|
|
|
|
|
2018-08-10 02:14:42 +00:00
|
|
|
return &attrs_bundle->attrs[uapi_bkey_attr(uapi_key_attr(idx))];
|
2017-08-03 13:07:04 +00:00
|
|
|
}
|
|
|
|
|
2018-03-28 06:27:42 +00:00
|
|
|
static inline int uverbs_attr_get_enum_id(const struct uverbs_attr_bundle *attrs_bundle,
|
|
|
|
u16 idx)
|
|
|
|
{
|
|
|
|
const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
|
|
|
|
|
|
|
|
if (IS_ERR(attr))
|
|
|
|
return PTR_ERR(attr);
|
|
|
|
|
|
|
|
return attr->ptr_attr.enum_id;
|
|
|
|
}
|
|
|
|
|
2018-04-05 15:53:25 +00:00
|
|
|
static inline void *uverbs_attr_get_obj(const struct uverbs_attr_bundle *attrs_bundle,
|
|
|
|
u16 idx)
|
|
|
|
{
|
2018-05-22 21:56:51 +00:00
|
|
|
const struct uverbs_attr *attr;
|
2018-04-05 15:53:25 +00:00
|
|
|
|
2018-05-22 21:56:51 +00:00
|
|
|
attr = uverbs_attr_get(attrs_bundle, idx);
|
|
|
|
if (IS_ERR(attr))
|
|
|
|
return ERR_CAST(attr);
|
2018-04-05 15:53:25 +00:00
|
|
|
|
2018-05-22 21:56:51 +00:00
|
|
|
return attr->obj_attr.uobject->object;
|
2018-04-05 15:53:25 +00:00
|
|
|
}
|
|
|
|
|
2018-05-31 13:43:28 +00:00
|
|
|
static inline struct ib_uobject *uverbs_attr_get_uobject(const struct uverbs_attr_bundle *attrs_bundle,
|
|
|
|
u16 idx)
|
|
|
|
{
|
|
|
|
const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
|
|
|
|
|
|
|
|
if (IS_ERR(attr))
|
|
|
|
return ERR_CAST(attr);
|
|
|
|
|
|
|
|
return attr->obj_attr.uobject;
|
|
|
|
}
|
|
|
|
|
2018-06-17 09:59:52 +00:00
|
|
|
static inline int
|
|
|
|
uverbs_attr_get_len(const struct uverbs_attr_bundle *attrs_bundle, u16 idx)
|
|
|
|
{
|
|
|
|
const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
|
|
|
|
|
|
|
|
if (IS_ERR(attr))
|
|
|
|
return PTR_ERR(attr);
|
|
|
|
|
|
|
|
return attr->ptr_attr.len;
|
|
|
|
}
|
|
|
|
|
2018-02-13 10:18:29 +00:00
|
|
|
static inline bool uverbs_attr_ptr_is_inline(const struct uverbs_attr *attr)
|
|
|
|
{
|
|
|
|
return attr->ptr_attr.len <= sizeof(attr->ptr_attr.data);
|
|
|
|
}
|
|
|
|
|
2018-06-17 09:59:52 +00:00
|
|
|
static inline void *uverbs_attr_get_alloced_ptr(
|
|
|
|
const struct uverbs_attr_bundle *attrs_bundle, u16 idx)
|
|
|
|
{
|
|
|
|
const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
|
|
|
|
|
|
|
|
if (IS_ERR(attr))
|
|
|
|
return (void *)attr;
|
|
|
|
|
|
|
|
return uverbs_attr_ptr_is_inline(attr) ? (void *)&attr->ptr_attr.data :
|
|
|
|
attr->ptr_attr.ptr;
|
|
|
|
}
|
|
|
|
|
2018-02-13 10:18:29 +00:00
|
|
|
static inline int _uverbs_copy_from(void *to,
|
2017-08-03 13:07:04 +00:00
|
|
|
const struct uverbs_attr_bundle *attrs_bundle,
|
2018-02-13 10:18:29 +00:00
|
|
|
size_t idx,
|
|
|
|
size_t size)
|
2017-08-03 13:07:04 +00:00
|
|
|
{
|
|
|
|
const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
|
|
|
|
|
|
|
|
if (IS_ERR(attr))
|
|
|
|
return PTR_ERR(attr);
|
|
|
|
|
2018-02-13 10:18:29 +00:00
|
|
|
/*
|
|
|
|
* Validation ensures attr->ptr_attr.len >= size. If the caller is
|
2018-03-19 13:02:36 +00:00
|
|
|
* using UVERBS_ATTR_SPEC_F_MIN_SZ_OR_ZERO then it must call
|
|
|
|
* uverbs_copy_from_or_zero.
|
2018-02-13 10:18:29 +00:00
|
|
|
*/
|
|
|
|
if (unlikely(size < attr->ptr_attr.len))
|
|
|
|
return -EINVAL;
|
|
|
|
|
|
|
|
if (uverbs_attr_ptr_is_inline(attr))
|
2017-08-03 13:07:04 +00:00
|
|
|
memcpy(to, &attr->ptr_attr.data, attr->ptr_attr.len);
|
2018-02-13 10:18:31 +00:00
|
|
|
else if (copy_from_user(to, u64_to_user_ptr(attr->ptr_attr.data),
|
|
|
|
attr->ptr_attr.len))
|
2017-08-03 13:07:04 +00:00
|
|
|
return -EFAULT;
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2018-03-19 13:02:36 +00:00
|
|
|
static inline int _uverbs_copy_from_or_zero(void *to,
|
|
|
|
const struct uverbs_attr_bundle *attrs_bundle,
|
|
|
|
size_t idx,
|
|
|
|
size_t size)
|
|
|
|
{
|
|
|
|
const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
|
|
|
|
size_t min_size;
|
|
|
|
|
|
|
|
if (IS_ERR(attr))
|
|
|
|
return PTR_ERR(attr);
|
|
|
|
|
|
|
|
min_size = min_t(size_t, size, attr->ptr_attr.len);
|
|
|
|
|
|
|
|
if (uverbs_attr_ptr_is_inline(attr))
|
|
|
|
memcpy(to, &attr->ptr_attr.data, min_size);
|
|
|
|
else if (copy_from_user(to, u64_to_user_ptr(attr->ptr_attr.data),
|
|
|
|
min_size))
|
|
|
|
return -EFAULT;
|
|
|
|
|
|
|
|
if (size > min_size)
|
|
|
|
memset(to + min_size, 0, size - min_size);
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2017-08-03 13:07:04 +00:00
|
|
|
#define uverbs_copy_from(to, attrs_bundle, idx) \
|
2018-02-13 10:18:29 +00:00
|
|
|
_uverbs_copy_from(to, attrs_bundle, idx, sizeof(*to))
|
2017-08-03 13:07:04 +00:00
|
|
|
|
2018-03-19 13:02:36 +00:00
|
|
|
#define uverbs_copy_from_or_zero(to, attrs_bundle, idx) \
|
|
|
|
_uverbs_copy_from_or_zero(to, attrs_bundle, idx, sizeof(*to))
|
|
|
|
|
2018-07-26 22:37:14 +00:00
|
|
|
#if IS_ENABLED(CONFIG_INFINIBAND_USER_ACCESS)
|
|
|
|
int uverbs_get_flags64(u64 *to, const struct uverbs_attr_bundle *attrs_bundle,
|
|
|
|
size_t idx, u64 allowed_bits);
|
|
|
|
int uverbs_get_flags32(u32 *to, const struct uverbs_attr_bundle *attrs_bundle,
|
|
|
|
size_t idx, u64 allowed_bits);
|
2018-08-10 02:14:39 +00:00
|
|
|
int uverbs_copy_to(const struct uverbs_attr_bundle *attrs_bundle, size_t idx,
|
|
|
|
const void *from, size_t size);
|
2018-08-10 02:14:40 +00:00
|
|
|
__malloc void *_uverbs_alloc(struct uverbs_attr_bundle *bundle, size_t size,
|
|
|
|
gfp_t flags);
|
|
|
|
|
|
|
|
static inline __malloc void *uverbs_alloc(struct uverbs_attr_bundle *bundle,
|
|
|
|
size_t size)
|
|
|
|
{
|
|
|
|
return _uverbs_alloc(bundle, size, GFP_KERNEL);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline __malloc void *uverbs_zalloc(struct uverbs_attr_bundle *bundle,
|
|
|
|
size_t size)
|
|
|
|
{
|
|
|
|
return _uverbs_alloc(bundle, size, GFP_KERNEL | __GFP_ZERO);
|
|
|
|
}
|
2018-07-26 22:37:14 +00:00
|
|
|
#else
|
|
|
|
static inline int
|
|
|
|
uverbs_get_flags64(u64 *to, const struct uverbs_attr_bundle *attrs_bundle,
|
|
|
|
size_t idx, u64 allowed_bits)
|
|
|
|
{
|
|
|
|
return -EINVAL;
|
|
|
|
}
|
|
|
|
static inline int
|
|
|
|
uverbs_get_flags32(u32 *to, const struct uverbs_attr_bundle *attrs_bundle,
|
|
|
|
size_t idx, u64 allowed_bits)
|
|
|
|
{
|
|
|
|
return -EINVAL;
|
|
|
|
}
|
2018-08-10 02:14:39 +00:00
|
|
|
static inline int uverbs_copy_to(const struct uverbs_attr_bundle *attrs_bundle,
|
|
|
|
size_t idx, const void *from, size_t size)
|
|
|
|
{
|
|
|
|
return -EINVAL;
|
|
|
|
}
|
2018-08-10 02:14:40 +00:00
|
|
|
static inline __malloc void *uverbs_alloc(struct uverbs_attr_bundle *bundle,
|
|
|
|
size_t size)
|
|
|
|
{
|
|
|
|
return ERR_PTR(-EINVAL);
|
|
|
|
}
|
|
|
|
static inline __malloc void *uverbs_zalloc(struct uverbs_attr_bundle *bundle,
|
|
|
|
size_t size)
|
|
|
|
{
|
|
|
|
return ERR_PTR(-EINVAL);
|
|
|
|
}
|
2018-07-26 22:37:14 +00:00
|
|
|
#endif
|
|
|
|
|
2017-08-03 13:07:00 +00:00
|
|
|
#endif
|