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.
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:
14 * Redistribution and use in source and binary forms, with or
15 * without modification, are permitted provided that the following
18 * - Redistributions of source code must retain the above
19 * copyright notice, this list of conditions and the following
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.
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
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>
46 #include <rdma/ib_verbs.h>
47 #include <rdma/ib_umem.h>
48 #include <rdma/ib_user_verbs.h>
50 #define INIT_UDATA(udata, ibuf, obuf, ilen, olen) \
52 (udata)->inbuf = (const void __user *) (ibuf); \
53 (udata)->outbuf = (void __user *) (obuf); \
54 (udata)->inlen = (ilen); \
55 (udata)->outlen = (olen); \
58 #define INIT_UDATA_BUF_OR_NULL(udata, ibuf, obuf, ilen, olen) \
60 (udata)->inbuf = (ilen) ? (const void __user *) (ibuf) : NULL; \
61 (udata)->outbuf = (olen) ? (void __user *) (obuf) : NULL; \
62 (udata)->inlen = (ilen); \
63 (udata)->outlen = (olen); \
67 * Our lifetime rules for these structs are the following:
69 * struct ib_uverbs_device: One reference is held by the module and
70 * released in ib_uverbs_remove_one(). Another reference is taken by
71 * ib_uverbs_open() each time the character special file is opened,
72 * and released in ib_uverbs_release_file() when the file is released.
74 * struct ib_uverbs_file: One reference is held by the VFS and
75 * released when the file is closed. Another reference is taken when
76 * an asynchronous event queue file is created and released when the
77 * event file is closed.
79 * struct ib_uverbs_event_queue: Base structure for
80 * struct ib_uverbs_async_event_file and struct ib_uverbs_completion_event_file.
81 * One reference is held by the VFS and released when the file is closed.
82 * For asynchronous event files, another reference is held by the corresponding
83 * main context file and released when that file is closed. For completion
84 * event files, a reference is taken when a CQ is created that uses the file,
85 * and released when the CQ is destroyed.
88 struct ib_uverbs_device {
91 struct completion comp;
93 struct ib_device __rcu *ib_dev;
96 struct rb_root xrcd_tree;
97 struct mutex xrcd_tree_mutex;
99 struct srcu_struct disassociate_srcu;
100 struct mutex lists_mutex; /* protect lists */
101 struct list_head uverbs_file_list;
102 struct list_head uverbs_events_file_list;
105 struct ib_uverbs_event_queue {
108 wait_queue_head_t poll_wait;
109 struct fasync_struct *async_queue;
110 struct list_head event_list;
113 struct ib_uverbs_async_event_file {
114 struct ib_uverbs_event_queue ev_queue;
115 struct ib_uverbs_file *uverbs_file;
117 struct list_head list;
120 struct ib_uverbs_completion_event_file {
121 struct ib_uobject_file uobj_file;
122 struct ib_uverbs_event_queue ev_queue;
125 struct ib_uverbs_file {
128 struct mutex cleanup_mutex; /* protect cleanup */
129 struct ib_uverbs_device *device;
130 struct ib_ucontext *ucontext;
131 struct ib_event_handler event_handler;
132 struct ib_uverbs_async_event_file *async_file;
133 struct list_head list;
137 /* spinlock protects write access to idr */
141 struct ib_uverbs_event {
143 struct ib_uverbs_async_event_desc async;
144 struct ib_uverbs_comp_event_desc comp;
146 struct list_head list;
147 struct list_head obj_list;
151 struct ib_uverbs_mcast_entry {
152 struct list_head list;
157 struct ib_uevent_object {
158 struct ib_uobject uobject;
159 struct list_head event_list;
163 struct ib_uxrcd_object {
164 struct ib_uobject uobject;
168 struct ib_usrq_object {
169 struct ib_uevent_object uevent;
170 struct ib_uxrcd_object *uxrcd;
173 struct ib_uqp_object {
174 struct ib_uevent_object uevent;
175 /* lock for mcast list */
176 struct mutex mcast_lock;
177 struct list_head mcast_list;
178 struct ib_uxrcd_object *uxrcd;
181 struct ib_uwq_object {
182 struct ib_uevent_object uevent;
185 struct ib_ucq_object {
186 struct ib_uobject uobject;
187 struct ib_uverbs_file *uverbs_file;
188 struct list_head comp_list;
189 struct list_head async_list;
190 u32 comp_events_reported;
191 u32 async_events_reported;
194 extern const struct file_operations uverbs_event_fops;
195 void ib_uverbs_init_event_queue(struct ib_uverbs_event_queue *ev_queue);
196 struct file *ib_uverbs_alloc_async_event_file(struct ib_uverbs_file *uverbs_file,
197 struct ib_device *ib_dev);
198 void ib_uverbs_free_async_event_file(struct ib_uverbs_file *uverbs_file);
200 void ib_uverbs_release_ucq(struct ib_uverbs_file *file,
201 struct ib_uverbs_completion_event_file *ev_file,
202 struct ib_ucq_object *uobj);
203 void ib_uverbs_release_uevent(struct ib_uverbs_file *file,
204 struct ib_uevent_object *uobj);
205 void ib_uverbs_release_file(struct kref *ref);
207 void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context);
208 void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr);
209 void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr);
210 void ib_uverbs_wq_event_handler(struct ib_event *event, void *context_ptr);
211 void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr);
212 void ib_uverbs_event_handler(struct ib_event_handler *handler,
213 struct ib_event *event);
214 int ib_uverbs_dealloc_xrcd(struct ib_uverbs_device *dev, struct ib_xrcd *xrcd,
215 enum rdma_remove_reason why);
217 int uverbs_dealloc_mw(struct ib_mw *mw);
218 void ib_uverbs_detach_umcast(struct ib_qp *qp,
219 struct ib_uqp_object *uobj);
221 struct ib_uverbs_flow_spec {
224 struct ib_uverbs_flow_spec_hdr hdr;
231 struct ib_uverbs_flow_spec_eth eth;
232 struct ib_uverbs_flow_spec_ipv4 ipv4;
233 struct ib_uverbs_flow_spec_tcp_udp tcp_udp;
234 struct ib_uverbs_flow_spec_ipv6 ipv6;
235 struct ib_uverbs_flow_spec_action_tag flow_tag;
239 #define IB_UVERBS_DECLARE_CMD(name) \
240 ssize_t ib_uverbs_##name(struct ib_uverbs_file *file, \
241 struct ib_device *ib_dev, \
242 const char __user *buf, int in_len, \
245 IB_UVERBS_DECLARE_CMD(get_context);
246 IB_UVERBS_DECLARE_CMD(query_device);
247 IB_UVERBS_DECLARE_CMD(query_port);
248 IB_UVERBS_DECLARE_CMD(alloc_pd);
249 IB_UVERBS_DECLARE_CMD(dealloc_pd);
250 IB_UVERBS_DECLARE_CMD(reg_mr);
251 IB_UVERBS_DECLARE_CMD(rereg_mr);
252 IB_UVERBS_DECLARE_CMD(dereg_mr);
253 IB_UVERBS_DECLARE_CMD(alloc_mw);
254 IB_UVERBS_DECLARE_CMD(dealloc_mw);
255 IB_UVERBS_DECLARE_CMD(create_comp_channel);
256 IB_UVERBS_DECLARE_CMD(create_cq);
257 IB_UVERBS_DECLARE_CMD(resize_cq);
258 IB_UVERBS_DECLARE_CMD(poll_cq);
259 IB_UVERBS_DECLARE_CMD(req_notify_cq);
260 IB_UVERBS_DECLARE_CMD(destroy_cq);
261 IB_UVERBS_DECLARE_CMD(create_qp);
262 IB_UVERBS_DECLARE_CMD(open_qp);
263 IB_UVERBS_DECLARE_CMD(query_qp);
264 IB_UVERBS_DECLARE_CMD(modify_qp);
265 IB_UVERBS_DECLARE_CMD(destroy_qp);
266 IB_UVERBS_DECLARE_CMD(post_send);
267 IB_UVERBS_DECLARE_CMD(post_recv);
268 IB_UVERBS_DECLARE_CMD(post_srq_recv);
269 IB_UVERBS_DECLARE_CMD(create_ah);
270 IB_UVERBS_DECLARE_CMD(destroy_ah);
271 IB_UVERBS_DECLARE_CMD(attach_mcast);
272 IB_UVERBS_DECLARE_CMD(detach_mcast);
273 IB_UVERBS_DECLARE_CMD(create_srq);
274 IB_UVERBS_DECLARE_CMD(modify_srq);
275 IB_UVERBS_DECLARE_CMD(query_srq);
276 IB_UVERBS_DECLARE_CMD(destroy_srq);
277 IB_UVERBS_DECLARE_CMD(create_xsrq);
278 IB_UVERBS_DECLARE_CMD(open_xrcd);
279 IB_UVERBS_DECLARE_CMD(close_xrcd);
281 #define IB_UVERBS_DECLARE_EX_CMD(name) \
282 int ib_uverbs_ex_##name(struct ib_uverbs_file *file, \
283 struct ib_device *ib_dev, \
284 struct ib_udata *ucore, \
285 struct ib_udata *uhw)
287 IB_UVERBS_DECLARE_EX_CMD(create_flow);
288 IB_UVERBS_DECLARE_EX_CMD(destroy_flow);
289 IB_UVERBS_DECLARE_EX_CMD(query_device);
290 IB_UVERBS_DECLARE_EX_CMD(create_cq);
291 IB_UVERBS_DECLARE_EX_CMD(create_qp);
292 IB_UVERBS_DECLARE_EX_CMD(create_wq);
293 IB_UVERBS_DECLARE_EX_CMD(modify_wq);
294 IB_UVERBS_DECLARE_EX_CMD(destroy_wq);
295 IB_UVERBS_DECLARE_EX_CMD(create_rwq_ind_table);
296 IB_UVERBS_DECLARE_EX_CMD(destroy_rwq_ind_table);
297 IB_UVERBS_DECLARE_EX_CMD(modify_qp);
299 #endif /* UVERBS_H */