Commit | Line | Data |
---|---|---|
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> |
bc38a6ab | 49 | |
f21519b2 YD |
50 | #define INIT_UDATA(udata, ibuf, obuf, ilen, olen) \ |
51 | do { \ | |
309243ec | 52 | (udata)->inbuf = (const void __user *) (ibuf); \ |
f21519b2 YD |
53 | (udata)->outbuf = (void __user *) (obuf); \ |
54 | (udata)->inlen = (ilen); \ | |
55 | (udata)->outlen = (olen); \ | |
56 | } while (0) | |
57 | ||
a96e4e2f RD |
58 | #define INIT_UDATA_BUF_OR_NULL(udata, ibuf, obuf, ilen, olen) \ |
59 | do { \ | |
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); \ | |
64 | } while (0) | |
65 | ||
70a30e16 RD |
66 | /* |
67 | * Our lifetime rules for these structs are the following: | |
68 | * | |
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. | |
73 | * | |
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. | |
78 | * | |
79 | * struct ib_uverbs_event_file: One reference is held by the VFS and | |
80 | * released when the file is closed. For asynchronous event files, | |
81 | * another reference is held by the corresponding main context file | |
82 | * and released when that file is closed. For completion event files, | |
83 | * a reference is taken when a CQ is created that uses the file, and | |
84 | * released when the CQ is destroyed. | |
85 | */ | |
86 | ||
bc38a6ab | 87 | struct ib_uverbs_device { |
35d4a0b6 | 88 | atomic_t refcount; |
055422dd | 89 | int num_comp_vectors; |
fd60ae40 | 90 | struct completion comp; |
f4e91eb4 | 91 | struct device *dev; |
036b1063 | 92 | struct ib_device __rcu *ib_dev; |
055422dd AC |
93 | int devnum; |
94 | struct cdev cdev; | |
53d0bd1e SH |
95 | struct rb_root xrcd_tree; |
96 | struct mutex xrcd_tree_mutex; | |
35d4a0b6 | 97 | struct kobject kobj; |
036b1063 YH |
98 | struct srcu_struct disassociate_srcu; |
99 | struct mutex lists_mutex; /* protect lists */ | |
100 | struct list_head uverbs_file_list; | |
101 | struct list_head uverbs_events_file_list; | |
bc38a6ab RD |
102 | }; |
103 | ||
104 | struct ib_uverbs_event_file { | |
105 | struct kref ref; | |
830a3871 | 106 | int is_async; |
bc38a6ab RD |
107 | struct ib_uverbs_file *uverbs_file; |
108 | spinlock_t lock; | |
830a3871 | 109 | int is_closed; |
bc38a6ab | 110 | wait_queue_head_t poll_wait; |
abdf119b | 111 | struct fasync_struct *async_queue; |
bc38a6ab | 112 | struct list_head event_list; |
036b1063 | 113 | struct list_head list; |
bc38a6ab RD |
114 | }; |
115 | ||
116 | struct ib_uverbs_file { | |
117 | struct kref ref; | |
95ed644f | 118 | struct mutex mutex; |
bc38a6ab RD |
119 | struct ib_uverbs_device *device; |
120 | struct ib_ucontext *ucontext; | |
121 | struct ib_event_handler event_handler; | |
6b73597e | 122 | struct ib_uverbs_event_file *async_file; |
036b1063 YH |
123 | struct list_head list; |
124 | int is_closed; | |
bc38a6ab RD |
125 | }; |
126 | ||
63aaf647 RD |
127 | struct ib_uverbs_event { |
128 | union { | |
129 | struct ib_uverbs_async_event_desc async; | |
130 | struct ib_uverbs_comp_event_desc comp; | |
131 | } desc; | |
bc38a6ab | 132 | struct list_head list; |
63aaf647 RD |
133 | struct list_head obj_list; |
134 | u32 *counter; | |
bc38a6ab RD |
135 | }; |
136 | ||
f4e40156 JM |
137 | struct ib_uverbs_mcast_entry { |
138 | struct list_head list; | |
139 | union ib_gid gid; | |
140 | u16 lid; | |
141 | }; | |
142 | ||
63aaf647 RD |
143 | struct ib_uevent_object { |
144 | struct ib_uobject uobject; | |
145 | struct list_head event_list; | |
146 | u32 events_reported; | |
bc38a6ab RD |
147 | }; |
148 | ||
53d0bd1e SH |
149 | struct ib_uxrcd_object { |
150 | struct ib_uobject uobject; | |
151 | atomic_t refcnt; | |
152 | }; | |
153 | ||
8541f8de SH |
154 | struct ib_usrq_object { |
155 | struct ib_uevent_object uevent; | |
156 | struct ib_uxrcd_object *uxrcd; | |
157 | }; | |
158 | ||
f4e40156 JM |
159 | struct ib_uqp_object { |
160 | struct ib_uevent_object uevent; | |
161 | struct list_head mcast_list; | |
846be90d | 162 | struct ib_uxrcd_object *uxrcd; |
f4e40156 JM |
163 | }; |
164 | ||
63aaf647 RD |
165 | struct ib_ucq_object { |
166 | struct ib_uobject uobject; | |
7162a3e0 | 167 | struct ib_uverbs_file *uverbs_file; |
63aaf647 RD |
168 | struct list_head comp_list; |
169 | struct list_head async_list; | |
170 | u32 comp_events_reported; | |
171 | u32 async_events_reported; | |
bc38a6ab RD |
172 | }; |
173 | ||
9ead190b | 174 | extern spinlock_t ib_uverbs_idr_lock; |
bc38a6ab RD |
175 | extern struct idr ib_uverbs_pd_idr; |
176 | extern struct idr ib_uverbs_mr_idr; | |
177 | extern struct idr ib_uverbs_mw_idr; | |
178 | extern struct idr ib_uverbs_ah_idr; | |
179 | extern struct idr ib_uverbs_cq_idr; | |
180 | extern struct idr ib_uverbs_qp_idr; | |
f520ba5a | 181 | extern struct idr ib_uverbs_srq_idr; |
53d0bd1e | 182 | extern struct idr ib_uverbs_xrcd_idr; |
436f2ad0 | 183 | extern struct idr ib_uverbs_rule_idr; |
bc38a6ab | 184 | |
9ead190b RD |
185 | void idr_remove_uobj(struct idr *idp, struct ib_uobject *uobj); |
186 | ||
6b73597e | 187 | struct file *ib_uverbs_alloc_event_file(struct ib_uverbs_file *uverbs_file, |
057aec0d | 188 | struct ib_device *ib_dev, |
b1e4594b | 189 | int is_async); |
03c40442 | 190 | void ib_uverbs_free_async_event_file(struct ib_uverbs_file *uverbs_file); |
6b73597e RD |
191 | struct ib_uverbs_event_file *ib_uverbs_lookup_comp_file(int fd); |
192 | ||
70a30e16 RD |
193 | void ib_uverbs_release_ucq(struct ib_uverbs_file *file, |
194 | struct ib_uverbs_event_file *ev_file, | |
195 | struct ib_ucq_object *uobj); | |
196 | void ib_uverbs_release_uevent(struct ib_uverbs_file *file, | |
197 | struct ib_uevent_object *uobj); | |
198 | ||
bc38a6ab RD |
199 | void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context); |
200 | void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr); | |
201 | void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr); | |
f520ba5a | 202 | void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr); |
6b73597e RD |
203 | void ib_uverbs_event_handler(struct ib_event_handler *handler, |
204 | struct ib_event *event); | |
53d0bd1e | 205 | void ib_uverbs_dealloc_xrcd(struct ib_uverbs_device *dev, struct ib_xrcd *xrcd); |
bc38a6ab | 206 | |
feb7c1e3 CH |
207 | int uverbs_dealloc_mw(struct ib_mw *mw); |
208 | ||
2490f20b YD |
209 | struct ib_uverbs_flow_spec { |
210 | union { | |
211 | union { | |
212 | struct ib_uverbs_flow_spec_hdr hdr; | |
213 | struct { | |
214 | __u32 type; | |
215 | __u16 size; | |
216 | __u16 reserved; | |
217 | }; | |
218 | }; | |
219 | struct ib_uverbs_flow_spec_eth eth; | |
220 | struct ib_uverbs_flow_spec_ipv4 ipv4; | |
221 | struct ib_uverbs_flow_spec_tcp_udp tcp_udp; | |
222 | }; | |
223 | }; | |
224 | ||
bc38a6ab RD |
225 | #define IB_UVERBS_DECLARE_CMD(name) \ |
226 | ssize_t ib_uverbs_##name(struct ib_uverbs_file *file, \ | |
057aec0d | 227 | struct ib_device *ib_dev, \ |
bc38a6ab RD |
228 | const char __user *buf, int in_len, \ |
229 | int out_len) | |
230 | ||
bc38a6ab RD |
231 | IB_UVERBS_DECLARE_CMD(get_context); |
232 | IB_UVERBS_DECLARE_CMD(query_device); | |
233 | IB_UVERBS_DECLARE_CMD(query_port); | |
bc38a6ab RD |
234 | IB_UVERBS_DECLARE_CMD(alloc_pd); |
235 | IB_UVERBS_DECLARE_CMD(dealloc_pd); | |
236 | IB_UVERBS_DECLARE_CMD(reg_mr); | |
7e6edb9b | 237 | IB_UVERBS_DECLARE_CMD(rereg_mr); |
bc38a6ab | 238 | IB_UVERBS_DECLARE_CMD(dereg_mr); |
6b52a12b SM |
239 | IB_UVERBS_DECLARE_CMD(alloc_mw); |
240 | IB_UVERBS_DECLARE_CMD(dealloc_mw); | |
6b73597e | 241 | IB_UVERBS_DECLARE_CMD(create_comp_channel); |
bc38a6ab | 242 | IB_UVERBS_DECLARE_CMD(create_cq); |
33b9b3ee | 243 | IB_UVERBS_DECLARE_CMD(resize_cq); |
67cdb40c RD |
244 | IB_UVERBS_DECLARE_CMD(poll_cq); |
245 | IB_UVERBS_DECLARE_CMD(req_notify_cq); | |
bc38a6ab RD |
246 | IB_UVERBS_DECLARE_CMD(destroy_cq); |
247 | IB_UVERBS_DECLARE_CMD(create_qp); | |
42849b26 | 248 | IB_UVERBS_DECLARE_CMD(open_qp); |
7ccc9a24 | 249 | IB_UVERBS_DECLARE_CMD(query_qp); |
bc38a6ab RD |
250 | IB_UVERBS_DECLARE_CMD(modify_qp); |
251 | IB_UVERBS_DECLARE_CMD(destroy_qp); | |
67cdb40c RD |
252 | IB_UVERBS_DECLARE_CMD(post_send); |
253 | IB_UVERBS_DECLARE_CMD(post_recv); | |
254 | IB_UVERBS_DECLARE_CMD(post_srq_recv); | |
255 | IB_UVERBS_DECLARE_CMD(create_ah); | |
256 | IB_UVERBS_DECLARE_CMD(destroy_ah); | |
bc38a6ab RD |
257 | IB_UVERBS_DECLARE_CMD(attach_mcast); |
258 | IB_UVERBS_DECLARE_CMD(detach_mcast); | |
f520ba5a RD |
259 | IB_UVERBS_DECLARE_CMD(create_srq); |
260 | IB_UVERBS_DECLARE_CMD(modify_srq); | |
8bdb0e86 | 261 | IB_UVERBS_DECLARE_CMD(query_srq); |
f520ba5a | 262 | IB_UVERBS_DECLARE_CMD(destroy_srq); |
8541f8de | 263 | IB_UVERBS_DECLARE_CMD(create_xsrq); |
53d0bd1e SH |
264 | IB_UVERBS_DECLARE_CMD(open_xrcd); |
265 | IB_UVERBS_DECLARE_CMD(close_xrcd); | |
f21519b2 | 266 | |
f21519b2 YD |
267 | #define IB_UVERBS_DECLARE_EX_CMD(name) \ |
268 | int ib_uverbs_ex_##name(struct ib_uverbs_file *file, \ | |
057aec0d | 269 | struct ib_device *ib_dev, \ |
f21519b2 YD |
270 | struct ib_udata *ucore, \ |
271 | struct ib_udata *uhw) | |
272 | ||
273 | IB_UVERBS_DECLARE_EX_CMD(create_flow); | |
274 | IB_UVERBS_DECLARE_EX_CMD(destroy_flow); | |
02d1aa7a | 275 | IB_UVERBS_DECLARE_EX_CMD(query_device); |
565197dd | 276 | IB_UVERBS_DECLARE_EX_CMD(create_cq); |
6d8a7497 | 277 | IB_UVERBS_DECLARE_EX_CMD(create_qp); |
f21519b2 | 278 | |
bc38a6ab | 279 | #endif /* UVERBS_H */ |