2016-09-04 19:30:30 +08:00
|
|
|
/*
|
|
|
|
|
* Copyright (c) 2016 Mellanox Technologies, LTD. All rights reserved.
|
|
|
|
|
*
|
|
|
|
|
* This software is available to you under a choice of one of two
|
|
|
|
|
* licenses. You may choose to be licensed under the terms of the GNU
|
|
|
|
|
* General Public License (GPL) Version 2, available from the file
|
|
|
|
|
* COPYING in the main directory of this source tree, or the
|
|
|
|
|
* OpenIB.org BSD license below:
|
|
|
|
|
*
|
|
|
|
|
* Redistribution and use in source and binary forms, with or
|
|
|
|
|
* without modification, are permitted provided that the following
|
|
|
|
|
* conditions are met:
|
|
|
|
|
*
|
|
|
|
|
* - Redistributions of source code must retain the above
|
|
|
|
|
* copyright notice, this list of conditions and the following
|
|
|
|
|
* disclaimer.
|
|
|
|
|
*
|
|
|
|
|
* - Redistributions in binary form must reproduce the above
|
|
|
|
|
* copyright notice, this list of conditions and the following
|
|
|
|
|
* disclaimer in the documentation and/or other materials
|
|
|
|
|
* provided with the distribution.
|
|
|
|
|
*
|
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
|
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
|
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
|
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
|
|
|
|
|
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
|
|
|
|
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
|
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
|
|
|
* SOFTWARE.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef RDMA_USER_IOCTL_H
|
|
|
|
|
#define RDMA_USER_IOCTL_H
|
|
|
|
|
|
|
|
|
|
#include <linux/types.h>
|
|
|
|
|
#include <linux/ioctl.h>
|
2016-09-04 19:30:31 +08:00
|
|
|
#include <rdma/ib_user_mad.h>
|
2016-09-04 19:30:33 +08:00
|
|
|
#include <rdma/hfi/hfi1_ioctl.h>
|
2016-09-04 19:30:30 +08:00
|
|
|
|
|
|
|
|
/* Documentation/ioctl/ioctl-number.txt */
|
2016-09-04 19:30:35 +08:00
|
|
|
#define RDMA_IOCTL_MAGIC 0x1b
|
2016-09-04 19:30:34 +08:00
|
|
|
/* Legacy name, for user space application which already use it */
|
2016-09-04 19:30:35 +08:00
|
|
|
#define IB_IOCTL_MAGIC RDMA_IOCTL_MAGIC
|
2016-09-04 19:30:33 +08: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 21:06:57 +08:00
|
|
|
#define RDMA_VERBS_IOCTL \
|
|
|
|
|
_IOWR(RDMA_IOCTL_MAGIC, 1, struct ib_uverbs_ioctl_hdr)
|
|
|
|
|
|
|
|
|
|
#define UVERBS_ID_NS_MASK 0xF000
|
|
|
|
|
#define UVERBS_ID_NS_SHIFT 12
|
|
|
|
|
|
|
|
|
|
enum {
|
|
|
|
|
/* User input */
|
|
|
|
|
UVERBS_ATTR_F_MANDATORY = 1U << 0,
|
|
|
|
|
/*
|
|
|
|
|
* Valid output bit should be ignored and considered set in
|
|
|
|
|
* mandatory fields. This bit is kernel output.
|
|
|
|
|
*/
|
|
|
|
|
UVERBS_ATTR_F_VALID_OUTPUT = 1U << 1,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
struct ib_uverbs_attr {
|
|
|
|
|
__u16 attr_id; /* command specific type attribute */
|
|
|
|
|
__u16 len; /* only for pointers */
|
|
|
|
|
__u16 flags; /* combination of UVERBS_ATTR_F_XXXX */
|
|
|
|
|
__u16 reserved;
|
|
|
|
|
__u64 data; /* ptr to command, inline data or idr/fd */
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
struct ib_uverbs_ioctl_hdr {
|
|
|
|
|
__u16 length;
|
|
|
|
|
__u16 object_id;
|
|
|
|
|
__u16 method_id;
|
|
|
|
|
__u16 num_attrs;
|
|
|
|
|
__u64 reserved;
|
|
|
|
|
struct ib_uverbs_attr attrs[0];
|
|
|
|
|
};
|
|
|
|
|
|
2016-09-04 19:30:33 +08:00
|
|
|
/*
|
2016-09-04 19:30:35 +08:00
|
|
|
* General blocks assignments
|
|
|
|
|
* It is closed on purpose do not expose it it user space
|
|
|
|
|
* #define MAD_CMD_BASE 0x00
|
|
|
|
|
* #define HFI1_CMD_BAS 0xE0
|
2016-09-04 19:30:33 +08:00
|
|
|
*/
|
|
|
|
|
|
2016-09-04 19:30:35 +08:00
|
|
|
/* MAD specific section */
|
|
|
|
|
#define IB_USER_MAD_REGISTER_AGENT _IOWR(RDMA_IOCTL_MAGIC, 0x01, struct ib_user_mad_reg_req)
|
|
|
|
|
#define IB_USER_MAD_UNREGISTER_AGENT _IOW(RDMA_IOCTL_MAGIC, 0x02, __u32)
|
|
|
|
|
#define IB_USER_MAD_ENABLE_PKEY _IO(RDMA_IOCTL_MAGIC, 0x03)
|
|
|
|
|
#define IB_USER_MAD_REGISTER_AGENT2 _IOWR(RDMA_IOCTL_MAGIC, 0x04, struct ib_user_mad_reg_req2)
|
2016-09-04 19:30:33 +08:00
|
|
|
|
2016-09-04 19:30:35 +08:00
|
|
|
/* HFI specific section */
|
|
|
|
|
/* allocate HFI and context */
|
|
|
|
|
#define HFI1_IOCTL_ASSIGN_CTXT _IOWR(RDMA_IOCTL_MAGIC, 0xE1, struct hfi1_user_info)
|
|
|
|
|
/* find out what resources we got */
|
|
|
|
|
#define HFI1_IOCTL_CTXT_INFO _IOW(RDMA_IOCTL_MAGIC, 0xE2, struct hfi1_ctxt_info)
|
|
|
|
|
/* set up userspace */
|
|
|
|
|
#define HFI1_IOCTL_USER_INFO _IOW(RDMA_IOCTL_MAGIC, 0xE3, struct hfi1_base_info)
|
|
|
|
|
/* update expected TID entries */
|
|
|
|
|
#define HFI1_IOCTL_TID_UPDATE _IOWR(RDMA_IOCTL_MAGIC, 0xE4, struct hfi1_tid_info)
|
|
|
|
|
/* free expected TID entries */
|
|
|
|
|
#define HFI1_IOCTL_TID_FREE _IOWR(RDMA_IOCTL_MAGIC, 0xE5, struct hfi1_tid_info)
|
|
|
|
|
/* force an update of PIO credit */
|
|
|
|
|
#define HFI1_IOCTL_CREDIT_UPD _IO(RDMA_IOCTL_MAGIC, 0xE6)
|
|
|
|
|
/* control receipt of packets */
|
|
|
|
|
#define HFI1_IOCTL_RECV_CTRL _IOW(RDMA_IOCTL_MAGIC, 0xE8, int)
|
|
|
|
|
/* set the kind of polling we want */
|
|
|
|
|
#define HFI1_IOCTL_POLL_TYPE _IOW(RDMA_IOCTL_MAGIC, 0xE9, int)
|
|
|
|
|
/* ack & clear user status bits */
|
|
|
|
|
#define HFI1_IOCTL_ACK_EVENT _IOW(RDMA_IOCTL_MAGIC, 0xEA, unsigned long)
|
|
|
|
|
/* set context's pkey */
|
|
|
|
|
#define HFI1_IOCTL_SET_PKEY _IOW(RDMA_IOCTL_MAGIC, 0xEB, __u16)
|
|
|
|
|
/* reset context's HW send context */
|
|
|
|
|
#define HFI1_IOCTL_CTXT_RESET _IO(RDMA_IOCTL_MAGIC, 0xEC)
|
|
|
|
|
/* read TID cache invalidations */
|
|
|
|
|
#define HFI1_IOCTL_TID_INVAL_READ _IOWR(RDMA_IOCTL_MAGIC, 0xED, struct hfi1_tid_info)
|
|
|
|
|
/* get the version of the user cdev */
|
|
|
|
|
#define HFI1_IOCTL_GET_VERS _IOR(RDMA_IOCTL_MAGIC, 0xEE, int)
|
2016-09-04 19:30:33 +08:00
|
|
|
|
2016-09-04 19:30:30 +08:00
|
|
|
#endif /* RDMA_USER_IOCTL_H */
|