tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/*
2 * Copyright (c) 2005 Topspin Communications. All rights reserved.
3 * Copyright (c) 2005, 2006 Cisco Systems. All rights reserved.
4 * Copyright (c) 2005 Mellanox Technologies. All rights reserved.
5 * Copyright (c) 2005 Voltaire, Inc. All rights reserved.
6 * Copyright (c) 2005 PathScale, Inc. All rights reserved.
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.
35 */
36
37#ifndef UVERBS_H
38#define UVERBS_H
39
40#include <linux/kref.h>
41#include <linux/idr.h>
42#include <linux/mutex.h>
43#include <linux/completion.h>
44#include <linux/cdev.h>
45
46#include <rdma/ib_verbs.h>
47#include <rdma/ib_umem.h>
48#include <rdma/ib_user_verbs.h>
49#include <rdma/uverbs_std_types.h>
50
51#define UVERBS_MODULE_NAME ib_uverbs
52#include <rdma/uverbs_named_ioctl.h>
53
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}
65
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{
72 ib_uverbs_init_udata(udata,
73 ilen ? ibuf : NULL, olen ? obuf : NULL,
74 ilen, olen);
75}
76
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 *
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.
97 */
98
99struct ib_uverbs_device {
100 atomic_t refcount;
101 u32 num_comp_vectors;
102 struct completion comp;
103 struct device dev;
104 /* First group for device attributes, NULL terminated array */
105 const struct attribute_group *groups[2];
106 struct ib_device __rcu *ib_dev;
107 int devnum;
108 struct cdev cdev;
109 struct rb_root xrcd_tree;
110 struct mutex xrcd_tree_mutex;
111 struct srcu_struct disassociate_srcu;
112 struct mutex lists_mutex; /* protect lists */
113 struct list_head uverbs_file_list;
114 struct uverbs_api *uapi;
115};
116
117struct ib_uverbs_event_queue {
118 spinlock_t lock;
119 int is_closed;
120 wait_queue_head_t poll_wait;
121 struct fasync_struct *async_queue;
122 struct list_head event_list;
123};
124
125struct ib_uverbs_async_event_file {
126 struct ib_uobject uobj;
127 struct ib_uverbs_event_queue ev_queue;
128 struct ib_event_handler event_handler;
129};
130
131struct ib_uverbs_completion_event_file {
132 struct ib_uobject uobj;
133 struct ib_uverbs_event_queue ev_queue;
134};
135
136struct ib_uverbs_file {
137 struct kref ref;
138 struct ib_uverbs_device *device;
139 struct mutex ucontext_lock;
140 /*
141 * ucontext must be accessed via ib_uverbs_get_ucontext() or with
142 * ucontext_lock held
143 */
144 struct ib_ucontext *ucontext;
145 struct ib_uverbs_async_event_file *async_file;
146 struct list_head list;
147
148 /*
149 * To access the uobjects list hw_destroy_rwsem must be held for write
150 * OR hw_destroy_rwsem held for read AND uobjects_lock held.
151 * hw_destroy_rwsem should be called across any destruction of the HW
152 * object of an associated uobject.
153 */
154 struct rw_semaphore hw_destroy_rwsem;
155 spinlock_t uobjects_lock;
156 struct list_head uobjects;
157
158 struct mutex umap_lock;
159 struct list_head umaps;
160 struct page *disassociate_page;
161
162 struct xarray idr;
163};
164
165struct ib_uverbs_event {
166 union {
167 struct ib_uverbs_async_event_desc async;
168 struct ib_uverbs_comp_event_desc comp;
169 } desc;
170 struct list_head list;
171 struct list_head obj_list;
172 u32 *counter;
173};
174
175struct ib_uverbs_mcast_entry {
176 struct list_head list;
177 union ib_gid gid;
178 u16 lid;
179};
180
181struct ib_uevent_object {
182 struct ib_uobject uobject;
183 /* List member for ib_uverbs_async_event_file list */
184 struct list_head event_list;
185 u32 events_reported;
186};
187
188struct ib_uxrcd_object {
189 struct ib_uobject uobject;
190 atomic_t refcnt;
191};
192
193struct ib_usrq_object {
194 struct ib_uevent_object uevent;
195 struct ib_uxrcd_object *uxrcd;
196};
197
198struct ib_uqp_object {
199 struct ib_uevent_object uevent;
200 /* lock for mcast list */
201 struct mutex mcast_lock;
202 struct list_head mcast_list;
203 struct ib_uxrcd_object *uxrcd;
204};
205
206struct ib_uwq_object {
207 struct ib_uevent_object uevent;
208};
209
210struct ib_ucq_object {
211 struct ib_uevent_object uevent;
212 struct list_head comp_list;
213 u32 comp_events_reported;
214};
215
216extern const struct file_operations uverbs_event_fops;
217extern const struct file_operations uverbs_async_event_fops;
218void ib_uverbs_init_event_queue(struct ib_uverbs_event_queue *ev_queue);
219void ib_uverbs_init_async_event_file(struct ib_uverbs_async_event_file *ev_file);
220void ib_uverbs_free_event_queue(struct ib_uverbs_event_queue *event_queue);
221void ib_uverbs_flow_resources_free(struct ib_uflow_resources *uflow_res);
222
223int ib_alloc_ucontext(struct uverbs_attr_bundle *attrs);
224int ib_init_ucontext(struct uverbs_attr_bundle *attrs);
225
226void ib_uverbs_release_ucq(struct ib_uverbs_completion_event_file *ev_file,
227 struct ib_ucq_object *uobj);
228void ib_uverbs_release_uevent(struct ib_uevent_object *uobj);
229void ib_uverbs_release_file(struct kref *ref);
230
231void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context);
232void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr);
233void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr);
234void ib_uverbs_wq_event_handler(struct ib_event *event, void *context_ptr);
235void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr);
236int ib_uverbs_dealloc_xrcd(struct ib_uobject *uobject, struct ib_xrcd *xrcd,
237 enum rdma_remove_reason why,
238 struct uverbs_attr_bundle *attrs);
239
240int uverbs_dealloc_mw(struct ib_mw *mw);
241void ib_uverbs_detach_umcast(struct ib_qp *qp,
242 struct ib_uqp_object *uobj);
243
244long ib_uverbs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
245
246struct ib_uverbs_flow_spec {
247 union {
248 union {
249 struct ib_uverbs_flow_spec_hdr hdr;
250 struct {
251 __u32 type;
252 __u16 size;
253 __u16 reserved;
254 };
255 };
256 struct ib_uverbs_flow_spec_eth eth;
257 struct ib_uverbs_flow_spec_ipv4 ipv4;
258 struct ib_uverbs_flow_spec_esp esp;
259 struct ib_uverbs_flow_spec_tcp_udp tcp_udp;
260 struct ib_uverbs_flow_spec_ipv6 ipv6;
261 struct ib_uverbs_flow_spec_action_tag flow_tag;
262 struct ib_uverbs_flow_spec_action_drop drop;
263 struct ib_uverbs_flow_spec_action_handle action;
264 struct ib_uverbs_flow_spec_action_count flow_count;
265 };
266};
267
268int ib_uverbs_kern_spec_to_ib_spec_filter(enum ib_flow_spec_type type,
269 const void *kern_spec_mask,
270 const void *kern_spec_val,
271 size_t kern_filter_sz,
272 union ib_flow_spec *ib_spec);
273
274/*
275 * ib_uverbs_query_port_resp.port_cap_flags started out as just a copy of the
276 * PortInfo CapabilityMask, but was extended with unique bits.
277 */
278static inline u32 make_port_cap_flags(const struct ib_port_attr *attr)
279{
280 u32 res;
281
282 /* All IBA CapabilityMask bits are passed through here, except bit 26,
283 * which is overridden with IP_BASED_GIDS. This is due to a historical
284 * mistake in the implementation of IP_BASED_GIDS. Otherwise all other
285 * bits match the IBA definition across all kernel versions.
286 */
287 res = attr->port_cap_flags & ~(u32)IB_UVERBS_PCF_IP_BASED_GIDS;
288
289 if (attr->ip_gids)
290 res |= IB_UVERBS_PCF_IP_BASED_GIDS;
291
292 return res;
293}
294
295
296void copy_port_attr_to_resp(struct ib_port_attr *attr,
297 struct ib_uverbs_query_port_resp *resp,
298 struct ib_device *ib_dev, u8 port_num);
299#endif /* UVERBS_H */