xref: /openbmc/linux/drivers/infiniband/core/uverbs.h (revision ec9bf373)
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 
54 static inline void
ib_uverbs_init_udata(struct ib_udata * udata,const void __user * ibuf,void __user * obuf,size_t ilen,size_t olen)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 }
65 
66 static inline void
ib_uverbs_init_udata_buf_or_null(struct ib_udata * udata,const void __user * ibuf,void __user * obuf,size_t ilen,size_t olen)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 {
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 
99 struct ib_uverbs_device {
100 	refcount_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 
117 struct 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 
125 struct 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 
131 struct ib_uverbs_completion_event_file {
132 	struct ib_uobject			uobj;
133 	struct ib_uverbs_event_queue		ev_queue;
134 };
135 
136 struct 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      *default_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 
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;
170 	struct list_head			list;
171 	struct list_head			obj_list;
172 	u32				       *counter;
173 };
174 
175 struct ib_uverbs_mcast_entry {
176 	struct list_head	list;
177 	union ib_gid 		gid;
178 	u16 			lid;
179 };
180 
181 struct ib_uevent_object {
182 	struct ib_uobject	uobject;
183 	struct ib_uverbs_async_event_file *event_file;
184 	/* List member for ib_uverbs_async_event_file list */
185 	struct list_head	event_list;
186 	u32			events_reported;
187 };
188 
189 struct ib_uxrcd_object {
190 	struct ib_uobject	uobject;
191 	atomic_t		refcnt;
192 };
193 
194 struct ib_usrq_object {
195 	struct ib_uevent_object	uevent;
196 	struct ib_uxrcd_object *uxrcd;
197 };
198 
199 struct ib_uqp_object {
200 	struct ib_uevent_object	uevent;
201 	/* lock for mcast list */
202 	struct mutex		mcast_lock;
203 	struct list_head 	mcast_list;
204 	struct ib_uxrcd_object *uxrcd;
205 };
206 
207 struct ib_uwq_object {
208 	struct ib_uevent_object	uevent;
209 };
210 
211 struct ib_ucq_object {
212 	struct ib_uevent_object uevent;
213 	struct list_head	comp_list;
214 	u32			comp_events_reported;
215 };
216 
217 extern const struct file_operations uverbs_event_fops;
218 extern const struct file_operations uverbs_async_event_fops;
219 void ib_uverbs_init_event_queue(struct ib_uverbs_event_queue *ev_queue);
220 void ib_uverbs_init_async_event_file(struct ib_uverbs_async_event_file *ev_file);
221 void ib_uverbs_free_event_queue(struct ib_uverbs_event_queue *event_queue);
222 void ib_uverbs_flow_resources_free(struct ib_uflow_resources *uflow_res);
223 int uverbs_async_event_release(struct inode *inode, struct file *filp);
224 
225 int ib_alloc_ucontext(struct uverbs_attr_bundle *attrs);
226 int ib_init_ucontext(struct uverbs_attr_bundle *attrs);
227 
228 void ib_uverbs_release_ucq(struct ib_uverbs_completion_event_file *ev_file,
229 			   struct ib_ucq_object *uobj);
230 void ib_uverbs_release_uevent(struct ib_uevent_object *uobj);
231 void ib_uverbs_release_file(struct kref *ref);
232 void ib_uverbs_async_handler(struct ib_uverbs_async_event_file *async_file,
233 			     __u64 element, __u64 event,
234 			     struct list_head *obj_list, u32 *counter);
235 
236 void ib_uverbs_comp_handler(struct ib_cq *cq, void *cq_context);
237 void ib_uverbs_cq_event_handler(struct ib_event *event, void *context_ptr);
238 void ib_uverbs_qp_event_handler(struct ib_event *event, void *context_ptr);
239 void ib_uverbs_wq_event_handler(struct ib_event *event, void *context_ptr);
240 void ib_uverbs_srq_event_handler(struct ib_event *event, void *context_ptr);
241 int ib_uverbs_dealloc_xrcd(struct ib_uobject *uobject, struct ib_xrcd *xrcd,
242 			   enum rdma_remove_reason why,
243 			   struct uverbs_attr_bundle *attrs);
244 
245 int uverbs_dealloc_mw(struct ib_mw *mw);
246 void ib_uverbs_detach_umcast(struct ib_qp *qp,
247 			     struct ib_uqp_object *uobj);
248 
249 long ib_uverbs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
250 
251 struct ib_uverbs_flow_spec {
252 	union {
253 		union {
254 			struct ib_uverbs_flow_spec_hdr hdr;
255 			struct {
256 				__u32 type;
257 				__u16 size;
258 				__u16 reserved;
259 			};
260 		};
261 		struct ib_uverbs_flow_spec_eth     eth;
262 		struct ib_uverbs_flow_spec_ipv4    ipv4;
263 		struct ib_uverbs_flow_spec_esp     esp;
264 		struct ib_uverbs_flow_spec_tcp_udp tcp_udp;
265 		struct ib_uverbs_flow_spec_ipv6    ipv6;
266 		struct ib_uverbs_flow_spec_action_tag	flow_tag;
267 		struct ib_uverbs_flow_spec_action_drop	drop;
268 		struct ib_uverbs_flow_spec_action_handle action;
269 		struct ib_uverbs_flow_spec_action_count flow_count;
270 	};
271 };
272 
273 int ib_uverbs_kern_spec_to_ib_spec_filter(enum ib_flow_spec_type type,
274 					  const void *kern_spec_mask,
275 					  const void *kern_spec_val,
276 					  size_t kern_filter_sz,
277 					  union ib_flow_spec *ib_spec);
278 
279 /*
280  * ib_uverbs_query_port_resp.port_cap_flags started out as just a copy of the
281  * PortInfo CapabilityMask, but was extended with unique bits.
282  */
make_port_cap_flags(const struct ib_port_attr * attr)283 static inline u32 make_port_cap_flags(const struct ib_port_attr *attr)
284 {
285 	u32 res;
286 
287 	/* All IBA CapabilityMask bits are passed through here, except bit 26,
288 	 * which is overridden with IP_BASED_GIDS. This is due to a historical
289 	 * mistake in the implementation of IP_BASED_GIDS. Otherwise all other
290 	 * bits match the IBA definition across all kernel versions.
291 	 */
292 	res = attr->port_cap_flags & ~(u32)IB_UVERBS_PCF_IP_BASED_GIDS;
293 
294 	if (attr->ip_gids)
295 		res |= IB_UVERBS_PCF_IP_BASED_GIDS;
296 
297 	return res;
298 }
299 
300 static inline struct ib_uverbs_async_event_file *
ib_uverbs_get_async_event(struct uverbs_attr_bundle * attrs,u16 id)301 ib_uverbs_get_async_event(struct uverbs_attr_bundle *attrs,
302 			  u16 id)
303 {
304 	struct ib_uobject *async_ev_file_uobj;
305 	struct ib_uverbs_async_event_file *async_ev_file;
306 
307 	async_ev_file_uobj = uverbs_attr_get_uobject(attrs, id);
308 	if (IS_ERR(async_ev_file_uobj))
309 		async_ev_file = READ_ONCE(attrs->ufile->default_async_file);
310 	else
311 		async_ev_file = container_of(async_ev_file_uobj,
312 				       struct ib_uverbs_async_event_file,
313 				       uobj);
314 	if (async_ev_file)
315 		uverbs_uobject_get(&async_ev_file->uobj);
316 	return async_ev_file;
317 }
318 
319 void copy_port_attr_to_resp(struct ib_port_attr *attr,
320 			    struct ib_uverbs_query_port_resp *resp,
321 			    struct ib_device *ib_dev, u8 port_num);
322 #endif /* UVERBS_H */
323