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>
45 #include <rdma/ib_verbs.h>
46 #include <rdma/ib_umem.h>
47 #include <rdma/ib_user_verbs.h>
50 * Our lifetime rules for these structs are the following:
52 * struct ib_uverbs_device: One reference is held by the module and
53 * released in ib_uverbs_remove_one(). Another reference is taken by
54 * ib_uverbs_open() each time the character special file is opened,
55 * and released in ib_uverbs_release_file() when the file is released.
57 * struct ib_uverbs_file: One reference is held by the VFS and
58 * released when the file is closed. Another reference is taken when
59 * an asynchronous event queue file is created and released when the
60 * event file is closed.
62 * struct ib_uverbs_event_file: One reference is held by the VFS and
63 * released when the file is closed. For asynchronous event files,
64 * another reference is held by the corresponding main context file
65 * and released when that file is closed. For completion event files,
66 * a reference is taken when a CQ is created that uses the file, and
67 * released when the CQ is destroyed.
70 struct ib_uverbs_device {
72 struct completion comp;
76 struct ib_device *ib_dev;
80 struct ib_uverbs_event_file {
83 struct ib_uverbs_file *uverbs_file;
85 wait_queue_head_t poll_wait;
86 struct fasync_struct *async_queue;
87 struct list_head event_list;
92 struct ib_uverbs_file {
95 struct ib_uverbs_device *device;
96 struct ib_ucontext *ucontext;
97 struct ib_event_handler event_handler;
98 struct ib_uverbs_event_file *async_file;
101 struct ib_uverbs_event {
103 struct ib_uverbs_async_event_desc async;
104 struct ib_uverbs_comp_event_desc comp;
106 struct list_head list;
107 struct list_head obj_list;
111 struct ib_uverbs_mcast_entry {
112 struct list_head list;
117 struct ib_uevent_object {
118 struct ib_uobject uobject;
119 struct list_head event_list;
123 struct ib_uqp_object {
124 struct ib_uevent_object uevent;
125 struct list_head mcast_list;
128 struct ib_ucq_object {
129 struct ib_uobject uobject;
130 struct ib_uverbs_file *uverbs_file;
131 struct list_head comp_list;
132 struct list_head async_list;
133 u32 comp_events_reported;
134 u32 async_events_reported;
137 struct ib_uxrcd_object {
138 struct ib_uobject uobject;
139 struct list_head xrc_reg_qp_list;
142 extern spinlock_t ib_uverbs_idr_lock;
143 extern struct idr ib_uverbs_pd_idr;
144 extern struct idr ib_uverbs_mr_idr;
145 extern struct idr ib_uverbs_mw_idr;
146 extern struct idr ib_uverbs_ah_idr;
147 extern struct idr ib_uverbs_cq_idr;
148 extern struct idr ib_uverbs_qp_idr;
149 extern struct idr ib_uverbs_srq_idr;
150 extern struct idr ib_uverbs_xrc_domain_idr;
152 void idr_remove_uobj(struct idr *idp, struct ib_uobject *uobj);
154 struct file *ib_uverbs_alloc_event_file(struct ib_uverbs_file *uverbs_file,
155 int is_async, int *fd);
156 struct ib_uverbs_event_file *ib_uverbs_lookup_comp_file(int fd);
158 void ib_uverbs_release_ucq(struct ib_uverbs_file *file,
159 struct ib_uverbs_event_file *ev_file,
160 struct ib_ucq_object *uobj);
161 void ib_uverbs_release_uevent(struct ib_uverbs_file *file,
162 struct ib_uevent_object *uobj);
164 void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context);
165 void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr);
166 void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr);
167 void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr);
168 void ib_uverbs_event_handler(struct ib_event_handler *handler,
169 struct ib_event *event);
170 void ib_uverbs_xrc_rcv_qp_event_handler(struct ib_event *event,
172 void ib_uverbs_dealloc_xrcd(struct ib_device *ib_dev,
173 struct ib_xrcd *xrcd);
174 int ib_uverbs_cleanup_xrc_rcv_qp(struct ib_uverbs_file *file,
175 struct ib_xrcd *xrcd, u32 qp_num);
177 #define IB_UVERBS_DECLARE_CMD(name) \
178 ssize_t ib_uverbs_##name(struct ib_uverbs_file *file, \
179 const char __user *buf, int in_len, \
182 IB_UVERBS_DECLARE_CMD(get_context);
183 IB_UVERBS_DECLARE_CMD(query_device);
184 IB_UVERBS_DECLARE_CMD(query_port);
185 IB_UVERBS_DECLARE_CMD(alloc_pd);
186 IB_UVERBS_DECLARE_CMD(dealloc_pd);
187 IB_UVERBS_DECLARE_CMD(reg_mr);
188 IB_UVERBS_DECLARE_CMD(dereg_mr);
189 IB_UVERBS_DECLARE_CMD(create_comp_channel);
190 IB_UVERBS_DECLARE_CMD(create_cq);
191 IB_UVERBS_DECLARE_CMD(resize_cq);
192 IB_UVERBS_DECLARE_CMD(poll_cq);
193 IB_UVERBS_DECLARE_CMD(req_notify_cq);
194 IB_UVERBS_DECLARE_CMD(destroy_cq);
195 IB_UVERBS_DECLARE_CMD(create_qp);
196 IB_UVERBS_DECLARE_CMD(query_qp);
197 IB_UVERBS_DECLARE_CMD(modify_qp);
198 IB_UVERBS_DECLARE_CMD(destroy_qp);
199 IB_UVERBS_DECLARE_CMD(post_send);
200 IB_UVERBS_DECLARE_CMD(post_recv);
201 IB_UVERBS_DECLARE_CMD(post_srq_recv);
202 IB_UVERBS_DECLARE_CMD(create_ah);
203 IB_UVERBS_DECLARE_CMD(destroy_ah);
204 IB_UVERBS_DECLARE_CMD(attach_mcast);
205 IB_UVERBS_DECLARE_CMD(detach_mcast);
206 IB_UVERBS_DECLARE_CMD(create_srq);
207 IB_UVERBS_DECLARE_CMD(modify_srq);
208 IB_UVERBS_DECLARE_CMD(query_srq);
209 IB_UVERBS_DECLARE_CMD(destroy_srq);
210 IB_UVERBS_DECLARE_CMD(create_xrc_srq);
211 IB_UVERBS_DECLARE_CMD(open_xrc_domain);
212 IB_UVERBS_DECLARE_CMD(close_xrc_domain);
213 IB_UVERBS_DECLARE_CMD(create_xrc_rcv_qp);
214 IB_UVERBS_DECLARE_CMD(modify_xrc_rcv_qp);
215 IB_UVERBS_DECLARE_CMD(query_xrc_rcv_qp);
216 IB_UVERBS_DECLARE_CMD(reg_xrc_rcv_qp);
217 IB_UVERBS_DECLARE_CMD(unreg_xrc_rcv_qp);
220 #endif /* UVERBS_H */