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
37 #include <linux/module.h>
38 #include <linux/init.h>
39 #include <linux/device.h>
40 #include <linux/err.h>
42 #include <linux/poll.h>
43 #include <linux/sched.h>
44 #include <linux/file.h>
45 #include <linux/cdev.h>
46 #include <linux/anon_inodes.h>
47 #include <linux/slab.h>
49 #include <asm/uaccess.h>
53 MODULE_AUTHOR("Roland Dreier");
54 MODULE_DESCRIPTION("InfiniBand userspace verbs access");
55 MODULE_LICENSE("Dual BSD/GPL");
58 IB_UVERBS_MAJOR
= 231,
59 IB_UVERBS_BASE_MINOR
= 192,
60 IB_UVERBS_MAX_DEVICES
= 32
63 #define IB_UVERBS_BASE_DEV MKDEV(IB_UVERBS_MAJOR, IB_UVERBS_BASE_MINOR)
65 static struct class *uverbs_class
;
67 DEFINE_SPINLOCK(ib_uverbs_idr_lock
);
68 DEFINE_IDR(ib_uverbs_pd_idr
);
69 DEFINE_IDR(ib_uverbs_mr_idr
);
70 DEFINE_IDR(ib_uverbs_mw_idr
);
71 DEFINE_IDR(ib_uverbs_ah_idr
);
72 DEFINE_IDR(ib_uverbs_cq_idr
);
73 DEFINE_IDR(ib_uverbs_qp_idr
);
74 DEFINE_IDR(ib_uverbs_srq_idr
);
75 DEFINE_IDR(ib_uverbs_xrcd_idr
);
76 DEFINE_IDR(ib_uverbs_rule_idr
);
78 static DEFINE_SPINLOCK(map_lock
);
79 static DECLARE_BITMAP(dev_map
, IB_UVERBS_MAX_DEVICES
);
81 static ssize_t (*uverbs_cmd_table
[])(struct ib_uverbs_file
*file
,
82 struct ib_device
*ib_dev
,
83 const char __user
*buf
, int in_len
,
85 [IB_USER_VERBS_CMD_GET_CONTEXT
] = ib_uverbs_get_context
,
86 [IB_USER_VERBS_CMD_QUERY_DEVICE
] = ib_uverbs_query_device
,
87 [IB_USER_VERBS_CMD_QUERY_PORT
] = ib_uverbs_query_port
,
88 [IB_USER_VERBS_CMD_ALLOC_PD
] = ib_uverbs_alloc_pd
,
89 [IB_USER_VERBS_CMD_DEALLOC_PD
] = ib_uverbs_dealloc_pd
,
90 [IB_USER_VERBS_CMD_REG_MR
] = ib_uverbs_reg_mr
,
91 [IB_USER_VERBS_CMD_REREG_MR
] = ib_uverbs_rereg_mr
,
92 [IB_USER_VERBS_CMD_DEREG_MR
] = ib_uverbs_dereg_mr
,
93 [IB_USER_VERBS_CMD_ALLOC_MW
] = ib_uverbs_alloc_mw
,
94 [IB_USER_VERBS_CMD_DEALLOC_MW
] = ib_uverbs_dealloc_mw
,
95 [IB_USER_VERBS_CMD_CREATE_COMP_CHANNEL
] = ib_uverbs_create_comp_channel
,
96 [IB_USER_VERBS_CMD_CREATE_CQ
] = ib_uverbs_create_cq
,
97 [IB_USER_VERBS_CMD_RESIZE_CQ
] = ib_uverbs_resize_cq
,
98 [IB_USER_VERBS_CMD_POLL_CQ
] = ib_uverbs_poll_cq
,
99 [IB_USER_VERBS_CMD_REQ_NOTIFY_CQ
] = ib_uverbs_req_notify_cq
,
100 [IB_USER_VERBS_CMD_DESTROY_CQ
] = ib_uverbs_destroy_cq
,
101 [IB_USER_VERBS_CMD_CREATE_QP
] = ib_uverbs_create_qp
,
102 [IB_USER_VERBS_CMD_QUERY_QP
] = ib_uverbs_query_qp
,
103 [IB_USER_VERBS_CMD_MODIFY_QP
] = ib_uverbs_modify_qp
,
104 [IB_USER_VERBS_CMD_DESTROY_QP
] = ib_uverbs_destroy_qp
,
105 [IB_USER_VERBS_CMD_POST_SEND
] = ib_uverbs_post_send
,
106 [IB_USER_VERBS_CMD_POST_RECV
] = ib_uverbs_post_recv
,
107 [IB_USER_VERBS_CMD_POST_SRQ_RECV
] = ib_uverbs_post_srq_recv
,
108 [IB_USER_VERBS_CMD_CREATE_AH
] = ib_uverbs_create_ah
,
109 [IB_USER_VERBS_CMD_DESTROY_AH
] = ib_uverbs_destroy_ah
,
110 [IB_USER_VERBS_CMD_ATTACH_MCAST
] = ib_uverbs_attach_mcast
,
111 [IB_USER_VERBS_CMD_DETACH_MCAST
] = ib_uverbs_detach_mcast
,
112 [IB_USER_VERBS_CMD_CREATE_SRQ
] = ib_uverbs_create_srq
,
113 [IB_USER_VERBS_CMD_MODIFY_SRQ
] = ib_uverbs_modify_srq
,
114 [IB_USER_VERBS_CMD_QUERY_SRQ
] = ib_uverbs_query_srq
,
115 [IB_USER_VERBS_CMD_DESTROY_SRQ
] = ib_uverbs_destroy_srq
,
116 [IB_USER_VERBS_CMD_OPEN_XRCD
] = ib_uverbs_open_xrcd
,
117 [IB_USER_VERBS_CMD_CLOSE_XRCD
] = ib_uverbs_close_xrcd
,
118 [IB_USER_VERBS_CMD_CREATE_XSRQ
] = ib_uverbs_create_xsrq
,
119 [IB_USER_VERBS_CMD_OPEN_QP
] = ib_uverbs_open_qp
,
122 static int (*uverbs_ex_cmd_table
[])(struct ib_uverbs_file
*file
,
123 struct ib_device
*ib_dev
,
124 struct ib_udata
*ucore
,
125 struct ib_udata
*uhw
) = {
126 [IB_USER_VERBS_EX_CMD_CREATE_FLOW
] = ib_uverbs_ex_create_flow
,
127 [IB_USER_VERBS_EX_CMD_DESTROY_FLOW
] = ib_uverbs_ex_destroy_flow
,
128 [IB_USER_VERBS_EX_CMD_QUERY_DEVICE
] = ib_uverbs_ex_query_device
,
129 [IB_USER_VERBS_EX_CMD_CREATE_CQ
] = ib_uverbs_ex_create_cq
,
130 [IB_USER_VERBS_EX_CMD_CREATE_QP
] = ib_uverbs_ex_create_qp
,
133 static void ib_uverbs_add_one(struct ib_device
*device
);
134 static void ib_uverbs_remove_one(struct ib_device
*device
, void *client_data
);
136 int uverbs_dealloc_mw(struct ib_mw
*mw
)
138 struct ib_pd
*pd
= mw
->pd
;
141 ret
= mw
->device
->dealloc_mw(mw
);
143 atomic_dec(&pd
->usecnt
);
147 static void ib_uverbs_release_dev(struct kobject
*kobj
)
149 struct ib_uverbs_device
*dev
=
150 container_of(kobj
, struct ib_uverbs_device
, kobj
);
152 cleanup_srcu_struct(&dev
->disassociate_srcu
);
156 static struct kobj_type ib_uverbs_dev_ktype
= {
157 .release
= ib_uverbs_release_dev
,
160 static void ib_uverbs_release_event_file(struct kref
*ref
)
162 struct ib_uverbs_event_file
*file
=
163 container_of(ref
, struct ib_uverbs_event_file
, ref
);
168 void ib_uverbs_release_ucq(struct ib_uverbs_file
*file
,
169 struct ib_uverbs_event_file
*ev_file
,
170 struct ib_ucq_object
*uobj
)
172 struct ib_uverbs_event
*evt
, *tmp
;
175 spin_lock_irq(&ev_file
->lock
);
176 list_for_each_entry_safe(evt
, tmp
, &uobj
->comp_list
, obj_list
) {
177 list_del(&evt
->list
);
180 spin_unlock_irq(&ev_file
->lock
);
182 kref_put(&ev_file
->ref
, ib_uverbs_release_event_file
);
185 spin_lock_irq(&file
->async_file
->lock
);
186 list_for_each_entry_safe(evt
, tmp
, &uobj
->async_list
, obj_list
) {
187 list_del(&evt
->list
);
190 spin_unlock_irq(&file
->async_file
->lock
);
193 void ib_uverbs_release_uevent(struct ib_uverbs_file
*file
,
194 struct ib_uevent_object
*uobj
)
196 struct ib_uverbs_event
*evt
, *tmp
;
198 spin_lock_irq(&file
->async_file
->lock
);
199 list_for_each_entry_safe(evt
, tmp
, &uobj
->event_list
, obj_list
) {
200 list_del(&evt
->list
);
203 spin_unlock_irq(&file
->async_file
->lock
);
206 static void ib_uverbs_detach_umcast(struct ib_qp
*qp
,
207 struct ib_uqp_object
*uobj
)
209 struct ib_uverbs_mcast_entry
*mcast
, *tmp
;
211 list_for_each_entry_safe(mcast
, tmp
, &uobj
->mcast_list
, list
) {
212 ib_detach_mcast(qp
, &mcast
->gid
, mcast
->lid
);
213 list_del(&mcast
->list
);
218 static int ib_uverbs_cleanup_ucontext(struct ib_uverbs_file
*file
,
219 struct ib_ucontext
*context
)
221 struct ib_uobject
*uobj
, *tmp
;
223 context
->closing
= 1;
225 list_for_each_entry_safe(uobj
, tmp
, &context
->ah_list
, list
) {
226 struct ib_ah
*ah
= uobj
->object
;
228 idr_remove_uobj(&ib_uverbs_ah_idr
, uobj
);
233 /* Remove MWs before QPs, in order to support type 2A MWs. */
234 list_for_each_entry_safe(uobj
, tmp
, &context
->mw_list
, list
) {
235 struct ib_mw
*mw
= uobj
->object
;
237 idr_remove_uobj(&ib_uverbs_mw_idr
, uobj
);
238 uverbs_dealloc_mw(mw
);
242 list_for_each_entry_safe(uobj
, tmp
, &context
->rule_list
, list
) {
243 struct ib_flow
*flow_id
= uobj
->object
;
245 idr_remove_uobj(&ib_uverbs_rule_idr
, uobj
);
246 ib_destroy_flow(flow_id
);
250 list_for_each_entry_safe(uobj
, tmp
, &context
->qp_list
, list
) {
251 struct ib_qp
*qp
= uobj
->object
;
252 struct ib_uqp_object
*uqp
=
253 container_of(uobj
, struct ib_uqp_object
, uevent
.uobject
);
255 idr_remove_uobj(&ib_uverbs_qp_idr
, uobj
);
256 if (qp
!= qp
->real_qp
) {
259 ib_uverbs_detach_umcast(qp
, uqp
);
262 ib_uverbs_release_uevent(file
, &uqp
->uevent
);
266 list_for_each_entry_safe(uobj
, tmp
, &context
->srq_list
, list
) {
267 struct ib_srq
*srq
= uobj
->object
;
268 struct ib_uevent_object
*uevent
=
269 container_of(uobj
, struct ib_uevent_object
, uobject
);
271 idr_remove_uobj(&ib_uverbs_srq_idr
, uobj
);
273 ib_uverbs_release_uevent(file
, uevent
);
277 list_for_each_entry_safe(uobj
, tmp
, &context
->cq_list
, list
) {
278 struct ib_cq
*cq
= uobj
->object
;
279 struct ib_uverbs_event_file
*ev_file
= cq
->cq_context
;
280 struct ib_ucq_object
*ucq
=
281 container_of(uobj
, struct ib_ucq_object
, uobject
);
283 idr_remove_uobj(&ib_uverbs_cq_idr
, uobj
);
285 ib_uverbs_release_ucq(file
, ev_file
, ucq
);
289 list_for_each_entry_safe(uobj
, tmp
, &context
->mr_list
, list
) {
290 struct ib_mr
*mr
= uobj
->object
;
292 idr_remove_uobj(&ib_uverbs_mr_idr
, uobj
);
297 mutex_lock(&file
->device
->xrcd_tree_mutex
);
298 list_for_each_entry_safe(uobj
, tmp
, &context
->xrcd_list
, list
) {
299 struct ib_xrcd
*xrcd
= uobj
->object
;
300 struct ib_uxrcd_object
*uxrcd
=
301 container_of(uobj
, struct ib_uxrcd_object
, uobject
);
303 idr_remove_uobj(&ib_uverbs_xrcd_idr
, uobj
);
304 ib_uverbs_dealloc_xrcd(file
->device
, xrcd
);
307 mutex_unlock(&file
->device
->xrcd_tree_mutex
);
309 list_for_each_entry_safe(uobj
, tmp
, &context
->pd_list
, list
) {
310 struct ib_pd
*pd
= uobj
->object
;
312 idr_remove_uobj(&ib_uverbs_pd_idr
, uobj
);
317 put_pid(context
->tgid
);
319 return context
->device
->dealloc_ucontext(context
);
322 static void ib_uverbs_comp_dev(struct ib_uverbs_device
*dev
)
324 complete(&dev
->comp
);
327 static void ib_uverbs_release_file(struct kref
*ref
)
329 struct ib_uverbs_file
*file
=
330 container_of(ref
, struct ib_uverbs_file
, ref
);
331 struct ib_device
*ib_dev
;
334 srcu_key
= srcu_read_lock(&file
->device
->disassociate_srcu
);
335 ib_dev
= srcu_dereference(file
->device
->ib_dev
,
336 &file
->device
->disassociate_srcu
);
337 if (ib_dev
&& !ib_dev
->disassociate_ucontext
)
338 module_put(ib_dev
->owner
);
339 srcu_read_unlock(&file
->device
->disassociate_srcu
, srcu_key
);
341 if (atomic_dec_and_test(&file
->device
->refcount
))
342 ib_uverbs_comp_dev(file
->device
);
347 static ssize_t
ib_uverbs_event_read(struct file
*filp
, char __user
*buf
,
348 size_t count
, loff_t
*pos
)
350 struct ib_uverbs_event_file
*file
= filp
->private_data
;
351 struct ib_uverbs_event
*event
;
355 spin_lock_irq(&file
->lock
);
357 while (list_empty(&file
->event_list
)) {
358 spin_unlock_irq(&file
->lock
);
360 if (filp
->f_flags
& O_NONBLOCK
)
363 if (wait_event_interruptible(file
->poll_wait
,
364 (!list_empty(&file
->event_list
) ||
365 /* The barriers built into wait_event_interruptible()
366 * and wake_up() guarentee this will see the null set
369 !file
->uverbs_file
->device
->ib_dev
)))
372 /* If device was disassociated and no event exists set an error */
373 if (list_empty(&file
->event_list
) &&
374 !file
->uverbs_file
->device
->ib_dev
)
377 spin_lock_irq(&file
->lock
);
380 event
= list_entry(file
->event_list
.next
, struct ib_uverbs_event
, list
);
383 eventsz
= sizeof (struct ib_uverbs_async_event_desc
);
385 eventsz
= sizeof (struct ib_uverbs_comp_event_desc
);
387 if (eventsz
> count
) {
391 list_del(file
->event_list
.next
);
392 if (event
->counter
) {
394 list_del(&event
->obj_list
);
398 spin_unlock_irq(&file
->lock
);
401 if (copy_to_user(buf
, event
, eventsz
))
412 static unsigned int ib_uverbs_event_poll(struct file
*filp
,
413 struct poll_table_struct
*wait
)
415 unsigned int pollflags
= 0;
416 struct ib_uverbs_event_file
*file
= filp
->private_data
;
418 poll_wait(filp
, &file
->poll_wait
, wait
);
420 spin_lock_irq(&file
->lock
);
421 if (!list_empty(&file
->event_list
))
422 pollflags
= POLLIN
| POLLRDNORM
;
423 spin_unlock_irq(&file
->lock
);
428 static int ib_uverbs_event_fasync(int fd
, struct file
*filp
, int on
)
430 struct ib_uverbs_event_file
*file
= filp
->private_data
;
432 return fasync_helper(fd
, filp
, on
, &file
->async_queue
);
435 static int ib_uverbs_event_close(struct inode
*inode
, struct file
*filp
)
437 struct ib_uverbs_event_file
*file
= filp
->private_data
;
438 struct ib_uverbs_event
*entry
, *tmp
;
439 int closed_already
= 0;
441 mutex_lock(&file
->uverbs_file
->device
->lists_mutex
);
442 spin_lock_irq(&file
->lock
);
443 closed_already
= file
->is_closed
;
445 list_for_each_entry_safe(entry
, tmp
, &file
->event_list
, list
) {
447 list_del(&entry
->obj_list
);
450 spin_unlock_irq(&file
->lock
);
451 if (!closed_already
) {
452 list_del(&file
->list
);
454 ib_unregister_event_handler(&file
->uverbs_file
->
457 mutex_unlock(&file
->uverbs_file
->device
->lists_mutex
);
459 kref_put(&file
->uverbs_file
->ref
, ib_uverbs_release_file
);
460 kref_put(&file
->ref
, ib_uverbs_release_event_file
);
465 static const struct file_operations uverbs_event_fops
= {
466 .owner
= THIS_MODULE
,
467 .read
= ib_uverbs_event_read
,
468 .poll
= ib_uverbs_event_poll
,
469 .release
= ib_uverbs_event_close
,
470 .fasync
= ib_uverbs_event_fasync
,
474 void ib_uverbs_comp_handler(struct ib_cq
*cq
, void *cq_context
)
476 struct ib_uverbs_event_file
*file
= cq_context
;
477 struct ib_ucq_object
*uobj
;
478 struct ib_uverbs_event
*entry
;
484 spin_lock_irqsave(&file
->lock
, flags
);
485 if (file
->is_closed
) {
486 spin_unlock_irqrestore(&file
->lock
, flags
);
490 entry
= kmalloc(sizeof *entry
, GFP_ATOMIC
);
492 spin_unlock_irqrestore(&file
->lock
, flags
);
496 uobj
= container_of(cq
->uobject
, struct ib_ucq_object
, uobject
);
498 entry
->desc
.comp
.cq_handle
= cq
->uobject
->user_handle
;
499 entry
->counter
= &uobj
->comp_events_reported
;
501 list_add_tail(&entry
->list
, &file
->event_list
);
502 list_add_tail(&entry
->obj_list
, &uobj
->comp_list
);
503 spin_unlock_irqrestore(&file
->lock
, flags
);
505 wake_up_interruptible(&file
->poll_wait
);
506 kill_fasync(&file
->async_queue
, SIGIO
, POLL_IN
);
509 static void ib_uverbs_async_handler(struct ib_uverbs_file
*file
,
510 __u64 element
, __u64 event
,
511 struct list_head
*obj_list
,
514 struct ib_uverbs_event
*entry
;
517 spin_lock_irqsave(&file
->async_file
->lock
, flags
);
518 if (file
->async_file
->is_closed
) {
519 spin_unlock_irqrestore(&file
->async_file
->lock
, flags
);
523 entry
= kmalloc(sizeof *entry
, GFP_ATOMIC
);
525 spin_unlock_irqrestore(&file
->async_file
->lock
, flags
);
529 entry
->desc
.async
.element
= element
;
530 entry
->desc
.async
.event_type
= event
;
531 entry
->desc
.async
.reserved
= 0;
532 entry
->counter
= counter
;
534 list_add_tail(&entry
->list
, &file
->async_file
->event_list
);
536 list_add_tail(&entry
->obj_list
, obj_list
);
537 spin_unlock_irqrestore(&file
->async_file
->lock
, flags
);
539 wake_up_interruptible(&file
->async_file
->poll_wait
);
540 kill_fasync(&file
->async_file
->async_queue
, SIGIO
, POLL_IN
);
543 void ib_uverbs_cq_event_handler(struct ib_event
*event
, void *context_ptr
)
545 struct ib_ucq_object
*uobj
= container_of(event
->element
.cq
->uobject
,
546 struct ib_ucq_object
, uobject
);
548 ib_uverbs_async_handler(uobj
->uverbs_file
, uobj
->uobject
.user_handle
,
549 event
->event
, &uobj
->async_list
,
550 &uobj
->async_events_reported
);
553 void ib_uverbs_qp_event_handler(struct ib_event
*event
, void *context_ptr
)
555 struct ib_uevent_object
*uobj
;
557 /* for XRC target qp's, check that qp is live */
558 if (!event
->element
.qp
->uobject
|| !event
->element
.qp
->uobject
->live
)
561 uobj
= container_of(event
->element
.qp
->uobject
,
562 struct ib_uevent_object
, uobject
);
564 ib_uverbs_async_handler(context_ptr
, uobj
->uobject
.user_handle
,
565 event
->event
, &uobj
->event_list
,
566 &uobj
->events_reported
);
569 void ib_uverbs_srq_event_handler(struct ib_event
*event
, void *context_ptr
)
571 struct ib_uevent_object
*uobj
;
573 uobj
= container_of(event
->element
.srq
->uobject
,
574 struct ib_uevent_object
, uobject
);
576 ib_uverbs_async_handler(context_ptr
, uobj
->uobject
.user_handle
,
577 event
->event
, &uobj
->event_list
,
578 &uobj
->events_reported
);
581 void ib_uverbs_event_handler(struct ib_event_handler
*handler
,
582 struct ib_event
*event
)
584 struct ib_uverbs_file
*file
=
585 container_of(handler
, struct ib_uverbs_file
, event_handler
);
587 ib_uverbs_async_handler(file
, event
->element
.port_num
, event
->event
,
591 void ib_uverbs_free_async_event_file(struct ib_uverbs_file
*file
)
593 kref_put(&file
->async_file
->ref
, ib_uverbs_release_event_file
);
594 file
->async_file
= NULL
;
597 struct file
*ib_uverbs_alloc_event_file(struct ib_uverbs_file
*uverbs_file
,
598 struct ib_device
*ib_dev
,
601 struct ib_uverbs_event_file
*ev_file
;
605 ev_file
= kzalloc(sizeof(*ev_file
), GFP_KERNEL
);
607 return ERR_PTR(-ENOMEM
);
609 kref_init(&ev_file
->ref
);
610 spin_lock_init(&ev_file
->lock
);
611 INIT_LIST_HEAD(&ev_file
->event_list
);
612 init_waitqueue_head(&ev_file
->poll_wait
);
613 ev_file
->uverbs_file
= uverbs_file
;
614 kref_get(&ev_file
->uverbs_file
->ref
);
615 ev_file
->async_queue
= NULL
;
616 ev_file
->is_closed
= 0;
618 filp
= anon_inode_getfile("[infinibandevent]", &uverbs_event_fops
,
623 mutex_lock(&uverbs_file
->device
->lists_mutex
);
624 list_add_tail(&ev_file
->list
,
625 &uverbs_file
->device
->uverbs_events_file_list
);
626 mutex_unlock(&uverbs_file
->device
->lists_mutex
);
629 WARN_ON(uverbs_file
->async_file
);
630 uverbs_file
->async_file
= ev_file
;
631 kref_get(&uverbs_file
->async_file
->ref
);
632 INIT_IB_EVENT_HANDLER(&uverbs_file
->event_handler
,
634 ib_uverbs_event_handler
);
635 ret
= ib_register_event_handler(&uverbs_file
->event_handler
);
639 /* At that point async file stuff was fully set */
640 ev_file
->is_async
= 1;
647 kref_put(&uverbs_file
->async_file
->ref
, ib_uverbs_release_event_file
);
648 uverbs_file
->async_file
= NULL
;
652 kref_put(&ev_file
->uverbs_file
->ref
, ib_uverbs_release_file
);
653 kref_put(&ev_file
->ref
, ib_uverbs_release_event_file
);
658 * Look up a completion event file by FD. If lookup is successful,
659 * takes a ref to the event file struct that it returns; if
660 * unsuccessful, returns NULL.
662 struct ib_uverbs_event_file
*ib_uverbs_lookup_comp_file(int fd
)
664 struct ib_uverbs_event_file
*ev_file
= NULL
;
665 struct fd f
= fdget(fd
);
670 if (f
.file
->f_op
!= &uverbs_event_fops
)
673 ev_file
= f
.file
->private_data
;
674 if (ev_file
->is_async
) {
679 kref_get(&ev_file
->ref
);
686 static int verify_command_mask(struct ib_device
*ib_dev
, __u32 command
)
690 if (command
<= IB_USER_VERBS_CMD_OPEN_QP
)
691 mask
= ib_dev
->uverbs_cmd_mask
;
693 mask
= ib_dev
->uverbs_ex_cmd_mask
;
695 if (mask
& ((u64
)1 << command
))
701 static ssize_t
ib_uverbs_write(struct file
*filp
, const char __user
*buf
,
702 size_t count
, loff_t
*pos
)
704 struct ib_uverbs_file
*file
= filp
->private_data
;
705 struct ib_device
*ib_dev
;
706 struct ib_uverbs_cmd_hdr hdr
;
712 if (count
< sizeof hdr
)
715 if (copy_from_user(&hdr
, buf
, sizeof hdr
))
718 srcu_key
= srcu_read_lock(&file
->device
->disassociate_srcu
);
719 ib_dev
= srcu_dereference(file
->device
->ib_dev
,
720 &file
->device
->disassociate_srcu
);
726 if (hdr
.command
& ~(__u32
)(IB_USER_VERBS_CMD_FLAGS_MASK
|
727 IB_USER_VERBS_CMD_COMMAND_MASK
)) {
732 command
= hdr
.command
& IB_USER_VERBS_CMD_COMMAND_MASK
;
733 if (verify_command_mask(ib_dev
, command
)) {
738 if (!file
->ucontext
&&
739 command
!= IB_USER_VERBS_CMD_GET_CONTEXT
) {
744 flags
= (hdr
.command
&
745 IB_USER_VERBS_CMD_FLAGS_MASK
) >> IB_USER_VERBS_CMD_FLAGS_SHIFT
;
748 if (command
>= ARRAY_SIZE(uverbs_cmd_table
) ||
749 !uverbs_cmd_table
[command
]) {
754 if (hdr
.in_words
* 4 != count
) {
759 ret
= uverbs_cmd_table
[command
](file
, ib_dev
,
764 } else if (flags
== IB_USER_VERBS_CMD_FLAG_EXTENDED
) {
765 struct ib_uverbs_ex_cmd_hdr ex_hdr
;
766 struct ib_udata ucore
;
768 size_t written_count
= count
;
770 if (command
>= ARRAY_SIZE(uverbs_ex_cmd_table
) ||
771 !uverbs_ex_cmd_table
[command
]) {
776 if (!file
->ucontext
) {
781 if (count
< (sizeof(hdr
) + sizeof(ex_hdr
))) {
786 if (copy_from_user(&ex_hdr
, buf
+ sizeof(hdr
), sizeof(ex_hdr
))) {
791 count
-= sizeof(hdr
) + sizeof(ex_hdr
);
792 buf
+= sizeof(hdr
) + sizeof(ex_hdr
);
794 if ((hdr
.in_words
+ ex_hdr
.provider_in_words
) * 8 != count
) {
799 if (ex_hdr
.cmd_hdr_reserved
) {
804 if (ex_hdr
.response
) {
805 if (!hdr
.out_words
&& !ex_hdr
.provider_out_words
) {
810 if (!access_ok(VERIFY_WRITE
,
811 (void __user
*) (unsigned long) ex_hdr
.response
,
812 (hdr
.out_words
+ ex_hdr
.provider_out_words
) * 8)) {
817 if (hdr
.out_words
|| ex_hdr
.provider_out_words
) {
823 INIT_UDATA_BUF_OR_NULL(&ucore
, buf
, (unsigned long) ex_hdr
.response
,
824 hdr
.in_words
* 8, hdr
.out_words
* 8);
826 INIT_UDATA_BUF_OR_NULL(&uhw
,
828 (unsigned long) ex_hdr
.response
+ ucore
.outlen
,
829 ex_hdr
.provider_in_words
* 8,
830 ex_hdr
.provider_out_words
* 8);
832 ret
= uverbs_ex_cmd_table
[command
](file
,
843 srcu_read_unlock(&file
->device
->disassociate_srcu
, srcu_key
);
847 static int ib_uverbs_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
849 struct ib_uverbs_file
*file
= filp
->private_data
;
850 struct ib_device
*ib_dev
;
854 srcu_key
= srcu_read_lock(&file
->device
->disassociate_srcu
);
855 ib_dev
= srcu_dereference(file
->device
->ib_dev
,
856 &file
->device
->disassociate_srcu
);
865 ret
= ib_dev
->mmap(file
->ucontext
, vma
);
867 srcu_read_unlock(&file
->device
->disassociate_srcu
, srcu_key
);
872 * ib_uverbs_open() does not need the BKL:
874 * - the ib_uverbs_device structures are properly reference counted and
875 * everything else is purely local to the file being created, so
876 * races against other open calls are not a problem;
877 * - there is no ioctl method to race against;
878 * - the open method will either immediately run -ENXIO, or all
879 * required initialization will be done.
881 static int ib_uverbs_open(struct inode
*inode
, struct file
*filp
)
883 struct ib_uverbs_device
*dev
;
884 struct ib_uverbs_file
*file
;
885 struct ib_device
*ib_dev
;
887 int module_dependent
;
890 dev
= container_of(inode
->i_cdev
, struct ib_uverbs_device
, cdev
);
891 if (!atomic_inc_not_zero(&dev
->refcount
))
894 srcu_key
= srcu_read_lock(&dev
->disassociate_srcu
);
895 mutex_lock(&dev
->lists_mutex
);
896 ib_dev
= srcu_dereference(dev
->ib_dev
,
897 &dev
->disassociate_srcu
);
903 /* In case IB device supports disassociate ucontext, there is no hard
904 * dependency between uverbs device and its low level device.
906 module_dependent
= !(ib_dev
->disassociate_ucontext
);
908 if (module_dependent
) {
909 if (!try_module_get(ib_dev
->owner
)) {
915 file
= kzalloc(sizeof(*file
), GFP_KERNEL
);
918 if (module_dependent
)
925 file
->ucontext
= NULL
;
926 file
->async_file
= NULL
;
927 kref_init(&file
->ref
);
928 mutex_init(&file
->mutex
);
930 filp
->private_data
= file
;
931 kobject_get(&dev
->kobj
);
932 list_add_tail(&file
->list
, &dev
->uverbs_file_list
);
933 mutex_unlock(&dev
->lists_mutex
);
934 srcu_read_unlock(&dev
->disassociate_srcu
, srcu_key
);
936 return nonseekable_open(inode
, filp
);
939 module_put(ib_dev
->owner
);
942 mutex_unlock(&dev
->lists_mutex
);
943 srcu_read_unlock(&dev
->disassociate_srcu
, srcu_key
);
944 if (atomic_dec_and_test(&dev
->refcount
))
945 ib_uverbs_comp_dev(dev
);
950 static int ib_uverbs_close(struct inode
*inode
, struct file
*filp
)
952 struct ib_uverbs_file
*file
= filp
->private_data
;
953 struct ib_uverbs_device
*dev
= file
->device
;
954 struct ib_ucontext
*ucontext
= NULL
;
956 mutex_lock(&file
->device
->lists_mutex
);
957 ucontext
= file
->ucontext
;
958 file
->ucontext
= NULL
;
959 if (!file
->is_closed
) {
960 list_del(&file
->list
);
963 mutex_unlock(&file
->device
->lists_mutex
);
965 ib_uverbs_cleanup_ucontext(file
, ucontext
);
967 if (file
->async_file
)
968 kref_put(&file
->async_file
->ref
, ib_uverbs_release_event_file
);
970 kref_put(&file
->ref
, ib_uverbs_release_file
);
971 kobject_put(&dev
->kobj
);
976 static const struct file_operations uverbs_fops
= {
977 .owner
= THIS_MODULE
,
978 .write
= ib_uverbs_write
,
979 .open
= ib_uverbs_open
,
980 .release
= ib_uverbs_close
,
984 static const struct file_operations uverbs_mmap_fops
= {
985 .owner
= THIS_MODULE
,
986 .write
= ib_uverbs_write
,
987 .mmap
= ib_uverbs_mmap
,
988 .open
= ib_uverbs_open
,
989 .release
= ib_uverbs_close
,
993 static struct ib_client uverbs_client
= {
995 .add
= ib_uverbs_add_one
,
996 .remove
= ib_uverbs_remove_one
999 static ssize_t
show_ibdev(struct device
*device
, struct device_attribute
*attr
,
1004 struct ib_uverbs_device
*dev
= dev_get_drvdata(device
);
1005 struct ib_device
*ib_dev
;
1010 srcu_key
= srcu_read_lock(&dev
->disassociate_srcu
);
1011 ib_dev
= srcu_dereference(dev
->ib_dev
, &dev
->disassociate_srcu
);
1013 ret
= sprintf(buf
, "%s\n", ib_dev
->name
);
1014 srcu_read_unlock(&dev
->disassociate_srcu
, srcu_key
);
1018 static DEVICE_ATTR(ibdev
, S_IRUGO
, show_ibdev
, NULL
);
1020 static ssize_t
show_dev_abi_version(struct device
*device
,
1021 struct device_attribute
*attr
, char *buf
)
1023 struct ib_uverbs_device
*dev
= dev_get_drvdata(device
);
1026 struct ib_device
*ib_dev
;
1030 srcu_key
= srcu_read_lock(&dev
->disassociate_srcu
);
1031 ib_dev
= srcu_dereference(dev
->ib_dev
, &dev
->disassociate_srcu
);
1033 ret
= sprintf(buf
, "%d\n", ib_dev
->uverbs_abi_ver
);
1034 srcu_read_unlock(&dev
->disassociate_srcu
, srcu_key
);
1038 static DEVICE_ATTR(abi_version
, S_IRUGO
, show_dev_abi_version
, NULL
);
1040 static CLASS_ATTR_STRING(abi_version
, S_IRUGO
,
1041 __stringify(IB_USER_VERBS_ABI_VERSION
));
1043 static dev_t overflow_maj
;
1044 static DECLARE_BITMAP(overflow_map
, IB_UVERBS_MAX_DEVICES
);
1047 * If we have more than IB_UVERBS_MAX_DEVICES, dynamically overflow by
1048 * requesting a new major number and doubling the number of max devices we
1049 * support. It's stupid, but simple.
1051 static int find_overflow_devnum(void)
1055 if (!overflow_maj
) {
1056 ret
= alloc_chrdev_region(&overflow_maj
, 0, IB_UVERBS_MAX_DEVICES
,
1057 "infiniband_verbs");
1059 pr_err("user_verbs: couldn't register dynamic device number\n");
1064 ret
= find_first_zero_bit(overflow_map
, IB_UVERBS_MAX_DEVICES
);
1065 if (ret
>= IB_UVERBS_MAX_DEVICES
)
1071 static void ib_uverbs_add_one(struct ib_device
*device
)
1075 struct ib_uverbs_device
*uverbs_dev
;
1078 if (!device
->alloc_ucontext
)
1081 uverbs_dev
= kzalloc(sizeof *uverbs_dev
, GFP_KERNEL
);
1085 ret
= init_srcu_struct(&uverbs_dev
->disassociate_srcu
);
1091 atomic_set(&uverbs_dev
->refcount
, 1);
1092 init_completion(&uverbs_dev
->comp
);
1093 uverbs_dev
->xrcd_tree
= RB_ROOT
;
1094 mutex_init(&uverbs_dev
->xrcd_tree_mutex
);
1095 kobject_init(&uverbs_dev
->kobj
, &ib_uverbs_dev_ktype
);
1096 mutex_init(&uverbs_dev
->lists_mutex
);
1097 INIT_LIST_HEAD(&uverbs_dev
->uverbs_file_list
);
1098 INIT_LIST_HEAD(&uverbs_dev
->uverbs_events_file_list
);
1100 spin_lock(&map_lock
);
1101 devnum
= find_first_zero_bit(dev_map
, IB_UVERBS_MAX_DEVICES
);
1102 if (devnum
>= IB_UVERBS_MAX_DEVICES
) {
1103 spin_unlock(&map_lock
);
1104 devnum
= find_overflow_devnum();
1108 spin_lock(&map_lock
);
1109 uverbs_dev
->devnum
= devnum
+ IB_UVERBS_MAX_DEVICES
;
1110 base
= devnum
+ overflow_maj
;
1111 set_bit(devnum
, overflow_map
);
1113 uverbs_dev
->devnum
= devnum
;
1114 base
= devnum
+ IB_UVERBS_BASE_DEV
;
1115 set_bit(devnum
, dev_map
);
1117 spin_unlock(&map_lock
);
1119 rcu_assign_pointer(uverbs_dev
->ib_dev
, device
);
1120 uverbs_dev
->num_comp_vectors
= device
->num_comp_vectors
;
1122 cdev_init(&uverbs_dev
->cdev
, NULL
);
1123 uverbs_dev
->cdev
.owner
= THIS_MODULE
;
1124 uverbs_dev
->cdev
.ops
= device
->mmap
? &uverbs_mmap_fops
: &uverbs_fops
;
1125 uverbs_dev
->cdev
.kobj
.parent
= &uverbs_dev
->kobj
;
1126 kobject_set_name(&uverbs_dev
->cdev
.kobj
, "uverbs%d", uverbs_dev
->devnum
);
1127 if (cdev_add(&uverbs_dev
->cdev
, base
, 1))
1130 uverbs_dev
->dev
= device_create(uverbs_class
, device
->dma_device
,
1131 uverbs_dev
->cdev
.dev
, uverbs_dev
,
1132 "uverbs%d", uverbs_dev
->devnum
);
1133 if (IS_ERR(uverbs_dev
->dev
))
1136 if (device_create_file(uverbs_dev
->dev
, &dev_attr_ibdev
))
1138 if (device_create_file(uverbs_dev
->dev
, &dev_attr_abi_version
))
1141 ib_set_client_data(device
, &uverbs_client
, uverbs_dev
);
1146 device_destroy(uverbs_class
, uverbs_dev
->cdev
.dev
);
1149 cdev_del(&uverbs_dev
->cdev
);
1150 if (uverbs_dev
->devnum
< IB_UVERBS_MAX_DEVICES
)
1151 clear_bit(devnum
, dev_map
);
1153 clear_bit(devnum
, overflow_map
);
1156 if (atomic_dec_and_test(&uverbs_dev
->refcount
))
1157 ib_uverbs_comp_dev(uverbs_dev
);
1158 wait_for_completion(&uverbs_dev
->comp
);
1159 kobject_put(&uverbs_dev
->kobj
);
1163 static void ib_uverbs_free_hw_resources(struct ib_uverbs_device
*uverbs_dev
,
1164 struct ib_device
*ib_dev
)
1166 struct ib_uverbs_file
*file
;
1167 struct ib_uverbs_event_file
*event_file
;
1168 struct ib_event event
;
1170 /* Pending running commands to terminate */
1171 synchronize_srcu(&uverbs_dev
->disassociate_srcu
);
1172 event
.event
= IB_EVENT_DEVICE_FATAL
;
1173 event
.element
.port_num
= 0;
1174 event
.device
= ib_dev
;
1176 mutex_lock(&uverbs_dev
->lists_mutex
);
1177 while (!list_empty(&uverbs_dev
->uverbs_file_list
)) {
1178 struct ib_ucontext
*ucontext
;
1180 file
= list_first_entry(&uverbs_dev
->uverbs_file_list
,
1181 struct ib_uverbs_file
, list
);
1182 file
->is_closed
= 1;
1183 ucontext
= file
->ucontext
;
1184 list_del(&file
->list
);
1185 file
->ucontext
= NULL
;
1186 kref_get(&file
->ref
);
1187 mutex_unlock(&uverbs_dev
->lists_mutex
);
1188 /* We must release the mutex before going ahead and calling
1189 * disassociate_ucontext. disassociate_ucontext might end up
1190 * indirectly calling uverbs_close, for example due to freeing
1191 * the resources (e.g mmput).
1193 ib_uverbs_event_handler(&file
->event_handler
, &event
);
1195 ib_dev
->disassociate_ucontext(ucontext
);
1196 ib_uverbs_cleanup_ucontext(file
, ucontext
);
1199 mutex_lock(&uverbs_dev
->lists_mutex
);
1200 kref_put(&file
->ref
, ib_uverbs_release_file
);
1203 while (!list_empty(&uverbs_dev
->uverbs_events_file_list
)) {
1204 event_file
= list_first_entry(&uverbs_dev
->
1205 uverbs_events_file_list
,
1206 struct ib_uverbs_event_file
,
1208 spin_lock_irq(&event_file
->lock
);
1209 event_file
->is_closed
= 1;
1210 spin_unlock_irq(&event_file
->lock
);
1212 list_del(&event_file
->list
);
1213 if (event_file
->is_async
) {
1214 ib_unregister_event_handler(&event_file
->uverbs_file
->
1216 event_file
->uverbs_file
->event_handler
.device
= NULL
;
1219 wake_up_interruptible(&event_file
->poll_wait
);
1220 kill_fasync(&event_file
->async_queue
, SIGIO
, POLL_IN
);
1222 mutex_unlock(&uverbs_dev
->lists_mutex
);
1225 static void ib_uverbs_remove_one(struct ib_device
*device
, void *client_data
)
1227 struct ib_uverbs_device
*uverbs_dev
= client_data
;
1228 int wait_clients
= 1;
1233 dev_set_drvdata(uverbs_dev
->dev
, NULL
);
1234 device_destroy(uverbs_class
, uverbs_dev
->cdev
.dev
);
1235 cdev_del(&uverbs_dev
->cdev
);
1237 if (uverbs_dev
->devnum
< IB_UVERBS_MAX_DEVICES
)
1238 clear_bit(uverbs_dev
->devnum
, dev_map
);
1240 clear_bit(uverbs_dev
->devnum
- IB_UVERBS_MAX_DEVICES
, overflow_map
);
1242 if (device
->disassociate_ucontext
) {
1243 /* We disassociate HW resources and immediately return.
1244 * Userspace will see a EIO errno for all future access.
1245 * Upon returning, ib_device may be freed internally and is not
1247 * uverbs_device is still available until all clients close
1248 * their files, then the uverbs device ref count will be zero
1249 * and its resources will be freed.
1250 * Note: At this point no more files can be opened since the
1251 * cdev was deleted, however active clients can still issue
1252 * commands and close their open files.
1254 rcu_assign_pointer(uverbs_dev
->ib_dev
, NULL
);
1255 ib_uverbs_free_hw_resources(uverbs_dev
, device
);
1259 if (atomic_dec_and_test(&uverbs_dev
->refcount
))
1260 ib_uverbs_comp_dev(uverbs_dev
);
1262 wait_for_completion(&uverbs_dev
->comp
);
1263 kobject_put(&uverbs_dev
->kobj
);
1266 static char *uverbs_devnode(struct device
*dev
, umode_t
*mode
)
1270 return kasprintf(GFP_KERNEL
, "infiniband/%s", dev_name(dev
));
1273 static int __init
ib_uverbs_init(void)
1277 ret
= register_chrdev_region(IB_UVERBS_BASE_DEV
, IB_UVERBS_MAX_DEVICES
,
1278 "infiniband_verbs");
1280 pr_err("user_verbs: couldn't register device number\n");
1284 uverbs_class
= class_create(THIS_MODULE
, "infiniband_verbs");
1285 if (IS_ERR(uverbs_class
)) {
1286 ret
= PTR_ERR(uverbs_class
);
1287 pr_err("user_verbs: couldn't create class infiniband_verbs\n");
1291 uverbs_class
->devnode
= uverbs_devnode
;
1293 ret
= class_create_file(uverbs_class
, &class_attr_abi_version
.attr
);
1295 pr_err("user_verbs: couldn't create abi_version attribute\n");
1299 ret
= ib_register_client(&uverbs_client
);
1301 pr_err("user_verbs: couldn't register client\n");
1308 class_destroy(uverbs_class
);
1311 unregister_chrdev_region(IB_UVERBS_BASE_DEV
, IB_UVERBS_MAX_DEVICES
);
1317 static void __exit
ib_uverbs_cleanup(void)
1319 ib_unregister_client(&uverbs_client
);
1320 class_destroy(uverbs_class
);
1321 unregister_chrdev_region(IB_UVERBS_BASE_DEV
, IB_UVERBS_MAX_DEVICES
);
1323 unregister_chrdev_region(overflow_maj
, IB_UVERBS_MAX_DEVICES
);
1324 idr_destroy(&ib_uverbs_pd_idr
);
1325 idr_destroy(&ib_uverbs_mr_idr
);
1326 idr_destroy(&ib_uverbs_mw_idr
);
1327 idr_destroy(&ib_uverbs_ah_idr
);
1328 idr_destroy(&ib_uverbs_cq_idr
);
1329 idr_destroy(&ib_uverbs_qp_idr
);
1330 idr_destroy(&ib_uverbs_srq_idr
);
1333 module_init(ib_uverbs_init
);
1334 module_exit(ib_uverbs_cleanup
);