Merge tag 'pci-v6.16-fixes-3' of git://git.kernel.org/pub/scm/linux/kernel/git/pci/pci
[linux-2.6-block.git] / drivers / infiniband / core / uverbs.h
CommitLineData
bc38a6ab
RD
1/*
2 * Copyright (c) 2005 Topspin Communications. All rights reserved.
33b9b3ee 3 * Copyright (c) 2005, 2006 Cisco Systems. All rights reserved.
2a1d9b7f
RD
4 * Copyright (c) 2005 Mellanox Technologies. All rights reserved.
5 * Copyright (c) 2005 Voltaire, Inc. All rights reserved.
67cdb40c 6 * Copyright (c) 2005 PathScale, Inc. All rights reserved.
bc38a6ab
RD
7 *
8 * This software is available to you under a choice of one of two
9 * licenses. You may choose to be licensed under the terms of the GNU
10 * General Public License (GPL) Version 2, available from the file
11 * COPYING in the main directory of this source tree, or the
12 * OpenIB.org BSD license below:
13 *
14 * Redistribution and use in source and binary forms, with or
15 * without modification, are permitted provided that the following
16 * conditions are met:
17 *
18 * - Redistributions of source code must retain the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer.
21 *
22 * - Redistributions in binary form must reproduce the above
23 * copyright notice, this list of conditions and the following
24 * disclaimer in the documentation and/or other materials
25 * provided with the distribution.
26 *
27 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
28 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
29 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
30 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
31 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
32 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
33 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
34 * SOFTWARE.
bc38a6ab
RD
35 */
36
37#ifndef UVERBS_H
38#define UVERBS_H
39
bc38a6ab
RD
40#include <linux/kref.h>
41#include <linux/idr.h>
95ed644f 42#include <linux/mutex.h>
fd60ae40 43#include <linux/completion.h>
055422dd 44#include <linux/cdev.h>
bc38a6ab 45
a4d61e84 46#include <rdma/ib_verbs.h>
f7c6a7b5 47#include <rdma/ib_umem.h>
a4d61e84 48#include <rdma/ib_user_verbs.h>
dfb13955 49#include <rdma/uverbs_std_types.h>
bc38a6ab 50
1f7ff9d5
MB
51#define UVERBS_MODULE_NAME ib_uverbs
52#include <rdma/uverbs_named_ioctl.h>
53
40a20339
AB
54static inline void
55ib_uverbs_init_udata(struct ib_udata *udata,
56 const void __user *ibuf,
57 void __user *obuf,
58 size_t ilen, size_t olen)
59{
60 udata->inbuf = ibuf;
61 udata->outbuf = obuf;
62 udata->inlen = ilen;
63 udata->outlen = olen;
64}
f21519b2 65
12f72772
AB
66static inline void
67ib_uverbs_init_udata_buf_or_null(struct ib_udata *udata,
68 const void __user *ibuf,
69 void __user *obuf,
70 size_t ilen, size_t olen)
71{
40a20339
AB
72 ib_uverbs_init_udata(udata,
73 ilen ? ibuf : NULL, olen ? obuf : NULL,
74 ilen, olen);
12f72772 75}
a96e4e2f 76
70a30e16
RD
77/*
78 * Our lifetime rules for these structs are the following:
79 *
80 * struct ib_uverbs_device: One reference is held by the module and
81 * released in ib_uverbs_remove_one(). Another reference is taken by
82 * ib_uverbs_open() each time the character special file is opened,
83 * and released in ib_uverbs_release_file() when the file is released.
84 *
85 * struct ib_uverbs_file: One reference is held by the VFS and
86 * released when the file is closed. Another reference is taken when
87 * an asynchronous event queue file is created and released when the
88 * event file is closed.
89 *
db1b5ddd
MB
90 * struct ib_uverbs_event_queue: Base structure for
91 * struct ib_uverbs_async_event_file and struct ib_uverbs_completion_event_file.
92 * One reference is held by the VFS and released when the file is closed.
93 * For asynchronous event files, another reference is held by the corresponding
94 * main context file and released when that file is closed. For completion
95 * event files, a reference is taken when a CQ is created that uses the file,
96 * and released when the CQ is destroyed.
70a30e16
RD
97 */
98
bc38a6ab 99struct ib_uverbs_device {
ec9bf373 100 refcount_t refcount;
a9018adf 101 u32 num_comp_vectors;
fd60ae40 102 struct completion comp;
c5c4d92e 103 struct device dev;
b53b1c08
PP
104 /* First group for device attributes, NULL terminated array */
105 const struct attribute_group *groups[2];
036b1063 106 struct ib_device __rcu *ib_dev;
055422dd
AC
107 int devnum;
108 struct cdev cdev;
53d0bd1e
SH
109 struct rb_root xrcd_tree;
110 struct mutex xrcd_tree_mutex;
036b1063
YH
111 struct srcu_struct disassociate_srcu;
112 struct mutex lists_mutex; /* protect lists */
113 struct list_head uverbs_file_list;
9ed3e5f4 114 struct uverbs_api *uapi;
bc38a6ab
RD
115};
116
db1b5ddd 117struct ib_uverbs_event_queue {
bc38a6ab 118 spinlock_t lock;
830a3871 119 int is_closed;
bc38a6ab 120 wait_queue_head_t poll_wait;
abdf119b 121 struct fasync_struct *async_queue;
bc38a6ab 122 struct list_head event_list;
1e7710f3
MB
123};
124
125struct ib_uverbs_async_event_file {
3e032c0e 126 struct ib_uobject uobj;
db1b5ddd 127 struct ib_uverbs_event_queue ev_queue;
3e032c0e 128 struct ib_event_handler event_handler;
bc38a6ab
RD
129};
130
1e7710f3 131struct ib_uverbs_completion_event_file {
d0259e82 132 struct ib_uobject uobj;
db1b5ddd 133 struct ib_uverbs_event_queue ev_queue;
1e7710f3
MB
134};
135
63aaf647
RD
136struct ib_uverbs_event {
137 union {
138 struct ib_uverbs_async_event_desc async;
139 struct ib_uverbs_comp_event_desc comp;
140 } desc;
bc38a6ab 141 struct list_head list;
63aaf647
RD
142 struct list_head obj_list;
143 u32 *counter;
bc38a6ab
RD
144};
145
f4e40156
JM
146struct ib_uverbs_mcast_entry {
147 struct list_head list;
148 union ib_gid gid;
149 u16 lid;
150};
151
63aaf647
RD
152struct ib_uevent_object {
153 struct ib_uobject uobject;
98a8890f 154 struct ib_uverbs_async_event_file *event_file;
4ec1dcfc 155 /* List member for ib_uverbs_async_event_file list */
63aaf647
RD
156 struct list_head event_list;
157 u32 events_reported;
bc38a6ab
RD
158};
159
53d0bd1e
SH
160struct ib_uxrcd_object {
161 struct ib_uobject uobject;
162 atomic_t refcnt;
163};
164
8541f8de
SH
165struct ib_usrq_object {
166 struct ib_uevent_object uevent;
167 struct ib_uxrcd_object *uxrcd;
168};
169
f4e40156
JM
170struct ib_uqp_object {
171 struct ib_uevent_object uevent;
f48b7269
MB
172 /* lock for mcast list */
173 struct mutex mcast_lock;
f4e40156 174 struct list_head mcast_list;
846be90d 175 struct ib_uxrcd_object *uxrcd;
f4e40156
JM
176};
177
f213c052
YH
178struct ib_uwq_object {
179 struct ib_uevent_object uevent;
180};
181
63aaf647 182struct ib_ucq_object {
4ec1dcfc 183 struct ib_uevent_object uevent;
63aaf647 184 struct list_head comp_list;
63aaf647 185 u32 comp_events_reported;
bc38a6ab
RD
186};
187
1e7710f3 188extern const struct file_operations uverbs_event_fops;
3e032c0e 189extern const struct file_operations uverbs_async_event_fops;
db1b5ddd 190void ib_uverbs_init_event_queue(struct ib_uverbs_event_queue *ev_queue);
3e032c0e
JG
191void ib_uverbs_init_async_event_file(struct ib_uverbs_async_event_file *ev_file);
192void ib_uverbs_free_event_queue(struct ib_uverbs_event_queue *event_queue);
9b828441 193void ib_uverbs_flow_resources_free(struct ib_uflow_resources *uflow_res);
c485b19d 194int uverbs_async_event_release(struct inode *inode, struct file *filp);
6b73597e 195
a1123418
JG
196int ib_alloc_ucontext(struct uverbs_attr_bundle *attrs);
197int ib_init_ucontext(struct uverbs_attr_bundle *attrs);
198
5c55cfd6 199void ib_uverbs_release_ucq(struct ib_uverbs_completion_event_file *ev_file,
70a30e16 200 struct ib_ucq_object *uobj);
5c55cfd6 201void ib_uverbs_release_uevent(struct ib_uevent_object *uobj);
cf8966b3 202void ib_uverbs_release_file(struct kref *ref);
ccfdbaa5
JG
203void ib_uverbs_async_handler(struct ib_uverbs_async_event_file *async_file,
204 __u64 element, __u64 event,
205 struct list_head *obj_list, u32 *counter);
70a30e16 206
bc38a6ab
RD
207void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context);
208void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr);
209void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr);
f213c052 210void ib_uverbs_wq_event_handler(struct ib_event *event, void *context_ptr);
f520ba5a 211void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr);
1c77483e 212int ib_uverbs_dealloc_xrcd(struct ib_uobject *uobject, struct ib_xrcd *xrcd,
bdeacabd
SR
213 enum rdma_remove_reason why,
214 struct uverbs_attr_bundle *attrs);
bc38a6ab 215
feb7c1e3 216int uverbs_dealloc_mw(struct ib_mw *mw);
6be60aed
MB
217void ib_uverbs_detach_umcast(struct ib_qp *qp,
218 struct ib_uqp_object *uobj);
feb7c1e3 219
8eb19e8e
MB
220long ib_uverbs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
221
2490f20b
YD
222struct ib_uverbs_flow_spec {
223 union {
224 union {
225 struct ib_uverbs_flow_spec_hdr hdr;
226 struct {
227 __u32 type;
228 __u16 size;
229 __u16 reserved;
230 };
231 };
232 struct ib_uverbs_flow_spec_eth eth;
233 struct ib_uverbs_flow_spec_ipv4 ipv4;
56ab0b38 234 struct ib_uverbs_flow_spec_esp esp;
2490f20b 235 struct ib_uverbs_flow_spec_tcp_udp tcp_udp;
4c2aae71 236 struct ib_uverbs_flow_spec_ipv6 ipv6;
94e03f11 237 struct ib_uverbs_flow_spec_action_tag flow_tag;
483a3966 238 struct ib_uverbs_flow_spec_action_drop drop;
9b828441 239 struct ib_uverbs_flow_spec_action_handle action;
b6ba4a9a 240 struct ib_uverbs_flow_spec_action_count flow_count;
2490f20b
YD
241 };
242};
243
766d8551
MB
244int ib_uverbs_kern_spec_to_ib_spec_filter(enum ib_flow_spec_type type,
245 const void *kern_spec_mask,
246 const void *kern_spec_val,
247 size_t kern_filter_sz,
248 union ib_flow_spec *ib_spec);
249
641d1207
MG
250/*
251 * ib_uverbs_query_port_resp.port_cap_flags started out as just a copy of the
252 * PortInfo CapabilityMask, but was extended with unique bits.
253 */
254static inline u32 make_port_cap_flags(const struct ib_port_attr *attr)
255{
256 u32 res;
257
258 /* All IBA CapabilityMask bits are passed through here, except bit 26,
259 * which is overridden with IP_BASED_GIDS. This is due to a historical
260 * mistake in the implementation of IP_BASED_GIDS. Otherwise all other
261 * bits match the IBA definition across all kernel versions.
262 */
263 res = attr->port_cap_flags & ~(u32)IB_UVERBS_PCF_IP_BASED_GIDS;
264
265 if (attr->ip_gids)
266 res |= IB_UVERBS_PCF_IP_BASED_GIDS;
267
268 return res;
269}
270
cda9ee49
YH
271static inline struct ib_uverbs_async_event_file *
272ib_uverbs_get_async_event(struct uverbs_attr_bundle *attrs,
273 u16 id)
274{
275 struct ib_uobject *async_ev_file_uobj;
276 struct ib_uverbs_async_event_file *async_ev_file;
277
278 async_ev_file_uobj = uverbs_attr_get_uobject(attrs, id);
279 if (IS_ERR(async_ev_file_uobj))
280 async_ev_file = READ_ONCE(attrs->ufile->default_async_file);
281 else
282 async_ev_file = container_of(async_ev_file_uobj,
283 struct ib_uverbs_async_event_file,
284 uobj);
285 if (async_ev_file)
286 uverbs_uobject_get(&async_ev_file->uobj);
287 return async_ev_file;
288}
641d1207
MG
289
290void copy_port_attr_to_resp(struct ib_port_attr *attr,
291 struct ib_uverbs_query_port_resp *resp,
292 struct ib_device *ib_dev, u8 port_num);
bc38a6ab 293#endif /* UVERBS_H */