]>
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> |
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 |
54 | static inline void |
55 | ib_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 |
66 | static inline void |
67 | ib_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 | 99 | struct ib_uverbs_device { |
35d4a0b6 | 100 | atomic_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 | 117 | struct 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 | ||
125 | struct 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 | 131 | struct ib_uverbs_completion_event_file { |
d0259e82 | 132 | struct ib_uobject uobj; |
db1b5ddd | 133 | struct ib_uverbs_event_queue ev_queue; |
1e7710f3 MB |
134 | }; |
135 | ||
bc38a6ab RD |
136 | struct ib_uverbs_file { |
137 | struct kref ref; | |
138 | struct ib_uverbs_device *device; | |
e951747a | 139 | struct mutex ucontext_lock; |
22fa27fb JG |
140 | /* |
141 | * ucontext must be accessed via ib_uverbs_get_ucontext() or with | |
142 | * ucontext_lock held | |
143 | */ | |
bc38a6ab | 144 | struct ib_ucontext *ucontext; |
3e032c0e | 145 | struct ib_uverbs_async_event_file *async_file; |
036b1063 | 146 | struct list_head list; |
771addf6 | 147 | |
87064277 JG |
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; | |
6a5e9c88 JG |
156 | struct list_head uobjects; |
157 | ||
5f9794dc JG |
158 | struct mutex umap_lock; |
159 | struct list_head umaps; | |
67f269b3 | 160 | struct page *disassociate_page; |
5f9794dc | 161 | |
b9b0f345 | 162 | struct xarray idr; |
bc38a6ab RD |
163 | }; |
164 | ||
63aaf647 RD |
165 | struct ib_uverbs_event { |
166 | union { | |
167 | struct ib_uverbs_async_event_desc async; | |
168 | struct ib_uverbs_comp_event_desc comp; | |
169 | } desc; | |
bc38a6ab | 170 | struct list_head list; |
63aaf647 RD |
171 | struct list_head obj_list; |
172 | u32 *counter; | |
bc38a6ab RD |
173 | }; |
174 | ||
f4e40156 JM |
175 | struct ib_uverbs_mcast_entry { |
176 | struct list_head list; | |
177 | union ib_gid gid; | |
178 | u16 lid; | |
179 | }; | |
180 | ||
63aaf647 RD |
181 | struct ib_uevent_object { |
182 | struct ib_uobject uobject; | |
4ec1dcfc | 183 | /* List member for ib_uverbs_async_event_file list */ |
63aaf647 RD |
184 | struct list_head event_list; |
185 | u32 events_reported; | |
bc38a6ab RD |
186 | }; |
187 | ||
53d0bd1e SH |
188 | struct ib_uxrcd_object { |
189 | struct ib_uobject uobject; | |
190 | atomic_t refcnt; | |
191 | }; | |
192 | ||
8541f8de SH |
193 | struct ib_usrq_object { |
194 | struct ib_uevent_object uevent; | |
195 | struct ib_uxrcd_object *uxrcd; | |
196 | }; | |
197 | ||
f4e40156 JM |
198 | struct ib_uqp_object { |
199 | struct ib_uevent_object uevent; | |
f48b7269 MB |
200 | /* lock for mcast list */ |
201 | struct mutex mcast_lock; | |
f4e40156 | 202 | struct list_head mcast_list; |
846be90d | 203 | struct ib_uxrcd_object *uxrcd; |
f4e40156 JM |
204 | }; |
205 | ||
f213c052 YH |
206 | struct ib_uwq_object { |
207 | struct ib_uevent_object uevent; | |
208 | }; | |
209 | ||
63aaf647 | 210 | struct ib_ucq_object { |
4ec1dcfc | 211 | struct ib_uevent_object uevent; |
63aaf647 | 212 | struct list_head comp_list; |
63aaf647 | 213 | u32 comp_events_reported; |
bc38a6ab RD |
214 | }; |
215 | ||
1e7710f3 | 216 | extern const struct file_operations uverbs_event_fops; |
3e032c0e | 217 | extern const struct file_operations uverbs_async_event_fops; |
db1b5ddd | 218 | void ib_uverbs_init_event_queue(struct ib_uverbs_event_queue *ev_queue); |
3e032c0e JG |
219 | void ib_uverbs_init_async_event_file(struct ib_uverbs_async_event_file *ev_file); |
220 | void ib_uverbs_free_event_queue(struct ib_uverbs_event_queue *event_queue); | |
9b828441 | 221 | void ib_uverbs_flow_resources_free(struct ib_uflow_resources *uflow_res); |
c485b19d | 222 | int uverbs_async_event_release(struct inode *inode, struct file *filp); |
6b73597e | 223 | |
a1123418 JG |
224 | int ib_alloc_ucontext(struct uverbs_attr_bundle *attrs); |
225 | int ib_init_ucontext(struct uverbs_attr_bundle *attrs); | |
226 | ||
5c55cfd6 | 227 | void ib_uverbs_release_ucq(struct ib_uverbs_completion_event_file *ev_file, |
70a30e16 | 228 | struct ib_ucq_object *uobj); |
5c55cfd6 | 229 | void ib_uverbs_release_uevent(struct ib_uevent_object *uobj); |
cf8966b3 | 230 | void ib_uverbs_release_file(struct kref *ref); |
ccfdbaa5 JG |
231 | void ib_uverbs_async_handler(struct ib_uverbs_async_event_file *async_file, |
232 | __u64 element, __u64 event, | |
233 | struct list_head *obj_list, u32 *counter); | |
70a30e16 | 234 | |
bc38a6ab RD |
235 | void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context); |
236 | void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr); | |
237 | void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr); | |
f213c052 | 238 | void ib_uverbs_wq_event_handler(struct ib_event *event, void *context_ptr); |
f520ba5a | 239 | void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr); |
1c77483e | 240 | int ib_uverbs_dealloc_xrcd(struct ib_uobject *uobject, struct ib_xrcd *xrcd, |
bdeacabd SR |
241 | enum rdma_remove_reason why, |
242 | struct uverbs_attr_bundle *attrs); | |
bc38a6ab | 243 | |
feb7c1e3 | 244 | int uverbs_dealloc_mw(struct ib_mw *mw); |
6be60aed MB |
245 | void ib_uverbs_detach_umcast(struct ib_qp *qp, |
246 | struct ib_uqp_object *uobj); | |
feb7c1e3 | 247 | |
8eb19e8e MB |
248 | long ib_uverbs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg); |
249 | ||
2490f20b YD |
250 | struct ib_uverbs_flow_spec { |
251 | union { | |
252 | union { | |
253 | struct ib_uverbs_flow_spec_hdr hdr; | |
254 | struct { | |
255 | __u32 type; | |
256 | __u16 size; | |
257 | __u16 reserved; | |
258 | }; | |
259 | }; | |
260 | struct ib_uverbs_flow_spec_eth eth; | |
261 | struct ib_uverbs_flow_spec_ipv4 ipv4; | |
56ab0b38 | 262 | struct ib_uverbs_flow_spec_esp esp; |
2490f20b | 263 | struct ib_uverbs_flow_spec_tcp_udp tcp_udp; |
4c2aae71 | 264 | struct ib_uverbs_flow_spec_ipv6 ipv6; |
94e03f11 | 265 | struct ib_uverbs_flow_spec_action_tag flow_tag; |
483a3966 | 266 | struct ib_uverbs_flow_spec_action_drop drop; |
9b828441 | 267 | struct ib_uverbs_flow_spec_action_handle action; |
b6ba4a9a | 268 | struct ib_uverbs_flow_spec_action_count flow_count; |
2490f20b YD |
269 | }; |
270 | }; | |
271 | ||
766d8551 MB |
272 | int ib_uverbs_kern_spec_to_ib_spec_filter(enum ib_flow_spec_type type, |
273 | const void *kern_spec_mask, | |
274 | const void *kern_spec_val, | |
275 | size_t kern_filter_sz, | |
276 | union ib_flow_spec *ib_spec); | |
277 | ||
641d1207 MG |
278 | /* |
279 | * ib_uverbs_query_port_resp.port_cap_flags started out as just a copy of the | |
280 | * PortInfo CapabilityMask, but was extended with unique bits. | |
281 | */ | |
282 | static inline u32 make_port_cap_flags(const struct ib_port_attr *attr) | |
283 | { | |
284 | u32 res; | |
285 | ||
286 | /* All IBA CapabilityMask bits are passed through here, except bit 26, | |
287 | * which is overridden with IP_BASED_GIDS. This is due to a historical | |
288 | * mistake in the implementation of IP_BASED_GIDS. Otherwise all other | |
289 | * bits match the IBA definition across all kernel versions. | |
290 | */ | |
291 | res = attr->port_cap_flags & ~(u32)IB_UVERBS_PCF_IP_BASED_GIDS; | |
292 | ||
293 | if (attr->ip_gids) | |
294 | res |= IB_UVERBS_PCF_IP_BASED_GIDS; | |
295 | ||
296 | return res; | |
297 | } | |
298 | ||
299 | ||
300 | void copy_port_attr_to_resp(struct ib_port_attr *attr, | |
301 | struct ib_uverbs_query_port_resp *resp, | |
302 | struct ib_device *ib_dev, u8 port_num); | |
bc38a6ab | 303 | #endif /* UVERBS_H */ |