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 static void ib_uverbs_release_dev(struct kobject
*kobj
)
138 struct ib_uverbs_device
*dev
=
139 container_of(kobj
, struct ib_uverbs_device
, kobj
);
141 cleanup_srcu_struct(&dev
->disassociate_srcu
);
145 static struct kobj_type ib_uverbs_dev_ktype
= {
146 .release
= ib_uverbs_release_dev
,
149 static void ib_uverbs_release_event_file(struct kref
*ref
)
151 struct ib_uverbs_event_file
*file
=
152 container_of(ref
, struct ib_uverbs_event_file
, ref
);
157 void ib_uverbs_release_ucq(struct ib_uverbs_file
*file
,
158 struct ib_uverbs_event_file
*ev_file
,
159 struct ib_ucq_object
*uobj
)
161 struct ib_uverbs_event
*evt
, *tmp
;
164 spin_lock_irq(&ev_file
->lock
);
165 list_for_each_entry_safe(evt
, tmp
, &uobj
->comp_list
, obj_list
) {
166 list_del(&evt
->list
);
169 spin_unlock_irq(&ev_file
->lock
);
171 kref_put(&ev_file
->ref
, ib_uverbs_release_event_file
);
174 spin_lock_irq(&file
->async_file
->lock
);
175 list_for_each_entry_safe(evt
, tmp
, &uobj
->async_list
, obj_list
) {
176 list_del(&evt
->list
);
179 spin_unlock_irq(&file
->async_file
->lock
);
182 void ib_uverbs_release_uevent(struct ib_uverbs_file
*file
,
183 struct ib_uevent_object
*uobj
)
185 struct ib_uverbs_event
*evt
, *tmp
;
187 spin_lock_irq(&file
->async_file
->lock
);
188 list_for_each_entry_safe(evt
, tmp
, &uobj
->event_list
, obj_list
) {
189 list_del(&evt
->list
);
192 spin_unlock_irq(&file
->async_file
->lock
);
195 static void ib_uverbs_detach_umcast(struct ib_qp
*qp
,
196 struct ib_uqp_object
*uobj
)
198 struct ib_uverbs_mcast_entry
*mcast
, *tmp
;
200 list_for_each_entry_safe(mcast
, tmp
, &uobj
->mcast_list
, list
) {
201 ib_detach_mcast(qp
, &mcast
->gid
, mcast
->lid
);
202 list_del(&mcast
->list
);
207 static int ib_uverbs_cleanup_ucontext(struct ib_uverbs_file
*file
,
208 struct ib_ucontext
*context
)
210 struct ib_uobject
*uobj
, *tmp
;
212 context
->closing
= 1;
214 list_for_each_entry_safe(uobj
, tmp
, &context
->ah_list
, list
) {
215 struct ib_ah
*ah
= uobj
->object
;
217 idr_remove_uobj(&ib_uverbs_ah_idr
, uobj
);
222 /* Remove MWs before QPs, in order to support type 2A MWs. */
223 list_for_each_entry_safe(uobj
, tmp
, &context
->mw_list
, list
) {
224 struct ib_mw
*mw
= uobj
->object
;
226 idr_remove_uobj(&ib_uverbs_mw_idr
, uobj
);
231 list_for_each_entry_safe(uobj
, tmp
, &context
->rule_list
, list
) {
232 struct ib_flow
*flow_id
= uobj
->object
;
234 idr_remove_uobj(&ib_uverbs_rule_idr
, uobj
);
235 ib_destroy_flow(flow_id
);
239 list_for_each_entry_safe(uobj
, tmp
, &context
->qp_list
, list
) {
240 struct ib_qp
*qp
= uobj
->object
;
241 struct ib_uqp_object
*uqp
=
242 container_of(uobj
, struct ib_uqp_object
, uevent
.uobject
);
244 idr_remove_uobj(&ib_uverbs_qp_idr
, uobj
);
245 if (qp
!= qp
->real_qp
) {
248 ib_uverbs_detach_umcast(qp
, uqp
);
251 ib_uverbs_release_uevent(file
, &uqp
->uevent
);
255 list_for_each_entry_safe(uobj
, tmp
, &context
->srq_list
, list
) {
256 struct ib_srq
*srq
= uobj
->object
;
257 struct ib_uevent_object
*uevent
=
258 container_of(uobj
, struct ib_uevent_object
, uobject
);
260 idr_remove_uobj(&ib_uverbs_srq_idr
, uobj
);
262 ib_uverbs_release_uevent(file
, uevent
);
266 list_for_each_entry_safe(uobj
, tmp
, &context
->cq_list
, list
) {
267 struct ib_cq
*cq
= uobj
->object
;
268 struct ib_uverbs_event_file
*ev_file
= cq
->cq_context
;
269 struct ib_ucq_object
*ucq
=
270 container_of(uobj
, struct ib_ucq_object
, uobject
);
272 idr_remove_uobj(&ib_uverbs_cq_idr
, uobj
);
274 ib_uverbs_release_ucq(file
, ev_file
, ucq
);
278 list_for_each_entry_safe(uobj
, tmp
, &context
->mr_list
, list
) {
279 struct ib_mr
*mr
= uobj
->object
;
281 idr_remove_uobj(&ib_uverbs_mr_idr
, uobj
);
286 mutex_lock(&file
->device
->xrcd_tree_mutex
);
287 list_for_each_entry_safe(uobj
, tmp
, &context
->xrcd_list
, list
) {
288 struct ib_xrcd
*xrcd
= uobj
->object
;
289 struct ib_uxrcd_object
*uxrcd
=
290 container_of(uobj
, struct ib_uxrcd_object
, uobject
);
292 idr_remove_uobj(&ib_uverbs_xrcd_idr
, uobj
);
293 ib_uverbs_dealloc_xrcd(file
->device
, xrcd
);
296 mutex_unlock(&file
->device
->xrcd_tree_mutex
);
298 list_for_each_entry_safe(uobj
, tmp
, &context
->pd_list
, list
) {
299 struct ib_pd
*pd
= uobj
->object
;
301 idr_remove_uobj(&ib_uverbs_pd_idr
, uobj
);
306 put_pid(context
->tgid
);
308 return context
->device
->dealloc_ucontext(context
);
311 static void ib_uverbs_comp_dev(struct ib_uverbs_device
*dev
)
313 complete(&dev
->comp
);
316 static void ib_uverbs_release_file(struct kref
*ref
)
318 struct ib_uverbs_file
*file
=
319 container_of(ref
, struct ib_uverbs_file
, ref
);
320 struct ib_device
*ib_dev
;
323 srcu_key
= srcu_read_lock(&file
->device
->disassociate_srcu
);
324 ib_dev
= srcu_dereference(file
->device
->ib_dev
,
325 &file
->device
->disassociate_srcu
);
326 if (ib_dev
&& !ib_dev
->disassociate_ucontext
)
327 module_put(ib_dev
->owner
);
328 srcu_read_unlock(&file
->device
->disassociate_srcu
, srcu_key
);
330 if (atomic_dec_and_test(&file
->device
->refcount
))
331 ib_uverbs_comp_dev(file
->device
);
336 static ssize_t
ib_uverbs_event_read(struct file
*filp
, char __user
*buf
,
337 size_t count
, loff_t
*pos
)
339 struct ib_uverbs_event_file
*file
= filp
->private_data
;
340 struct ib_uverbs_event
*event
;
344 spin_lock_irq(&file
->lock
);
346 while (list_empty(&file
->event_list
)) {
347 spin_unlock_irq(&file
->lock
);
349 if (filp
->f_flags
& O_NONBLOCK
)
352 if (wait_event_interruptible(file
->poll_wait
,
353 (!list_empty(&file
->event_list
) ||
354 /* The barriers built into wait_event_interruptible()
355 * and wake_up() guarentee this will see the null set
358 !file
->uverbs_file
->device
->ib_dev
)))
361 /* If device was disassociated and no event exists set an error */
362 if (list_empty(&file
->event_list
) &&
363 !file
->uverbs_file
->device
->ib_dev
)
366 spin_lock_irq(&file
->lock
);
369 event
= list_entry(file
->event_list
.next
, struct ib_uverbs_event
, list
);
372 eventsz
= sizeof (struct ib_uverbs_async_event_desc
);
374 eventsz
= sizeof (struct ib_uverbs_comp_event_desc
);
376 if (eventsz
> count
) {
380 list_del(file
->event_list
.next
);
381 if (event
->counter
) {
383 list_del(&event
->obj_list
);
387 spin_unlock_irq(&file
->lock
);
390 if (copy_to_user(buf
, event
, eventsz
))
401 static unsigned int ib_uverbs_event_poll(struct file
*filp
,
402 struct poll_table_struct
*wait
)
404 unsigned int pollflags
= 0;
405 struct ib_uverbs_event_file
*file
= filp
->private_data
;
407 poll_wait(filp
, &file
->poll_wait
, wait
);
409 spin_lock_irq(&file
->lock
);
410 if (!list_empty(&file
->event_list
))
411 pollflags
= POLLIN
| POLLRDNORM
;
412 spin_unlock_irq(&file
->lock
);
417 static int ib_uverbs_event_fasync(int fd
, struct file
*filp
, int on
)
419 struct ib_uverbs_event_file
*file
= filp
->private_data
;
421 return fasync_helper(fd
, filp
, on
, &file
->async_queue
);
424 static int ib_uverbs_event_close(struct inode
*inode
, struct file
*filp
)
426 struct ib_uverbs_event_file
*file
= filp
->private_data
;
427 struct ib_uverbs_event
*entry
, *tmp
;
428 int closed_already
= 0;
430 mutex_lock(&file
->uverbs_file
->device
->lists_mutex
);
431 spin_lock_irq(&file
->lock
);
432 closed_already
= file
->is_closed
;
434 list_for_each_entry_safe(entry
, tmp
, &file
->event_list
, list
) {
436 list_del(&entry
->obj_list
);
439 spin_unlock_irq(&file
->lock
);
440 if (!closed_already
) {
441 list_del(&file
->list
);
443 ib_unregister_event_handler(&file
->uverbs_file
->
446 mutex_unlock(&file
->uverbs_file
->device
->lists_mutex
);
448 kref_put(&file
->uverbs_file
->ref
, ib_uverbs_release_file
);
449 kref_put(&file
->ref
, ib_uverbs_release_event_file
);
454 static const struct file_operations uverbs_event_fops
= {
455 .owner
= THIS_MODULE
,
456 .read
= ib_uverbs_event_read
,
457 .poll
= ib_uverbs_event_poll
,
458 .release
= ib_uverbs_event_close
,
459 .fasync
= ib_uverbs_event_fasync
,
463 void ib_uverbs_comp_handler(struct ib_cq
*cq
, void *cq_context
)
465 struct ib_uverbs_event_file
*file
= cq_context
;
466 struct ib_ucq_object
*uobj
;
467 struct ib_uverbs_event
*entry
;
473 spin_lock_irqsave(&file
->lock
, flags
);
474 if (file
->is_closed
) {
475 spin_unlock_irqrestore(&file
->lock
, flags
);
479 entry
= kmalloc(sizeof *entry
, GFP_ATOMIC
);
481 spin_unlock_irqrestore(&file
->lock
, flags
);
485 uobj
= container_of(cq
->uobject
, struct ib_ucq_object
, uobject
);
487 entry
->desc
.comp
.cq_handle
= cq
->uobject
->user_handle
;
488 entry
->counter
= &uobj
->comp_events_reported
;
490 list_add_tail(&entry
->list
, &file
->event_list
);
491 list_add_tail(&entry
->obj_list
, &uobj
->comp_list
);
492 spin_unlock_irqrestore(&file
->lock
, flags
);
494 wake_up_interruptible(&file
->poll_wait
);
495 kill_fasync(&file
->async_queue
, SIGIO
, POLL_IN
);
498 static void ib_uverbs_async_handler(struct ib_uverbs_file
*file
,
499 __u64 element
, __u64 event
,
500 struct list_head
*obj_list
,
503 struct ib_uverbs_event
*entry
;
506 spin_lock_irqsave(&file
->async_file
->lock
, flags
);
507 if (file
->async_file
->is_closed
) {
508 spin_unlock_irqrestore(&file
->async_file
->lock
, flags
);
512 entry
= kmalloc(sizeof *entry
, GFP_ATOMIC
);
514 spin_unlock_irqrestore(&file
->async_file
->lock
, flags
);
518 entry
->desc
.async
.element
= element
;
519 entry
->desc
.async
.event_type
= event
;
520 entry
->desc
.async
.reserved
= 0;
521 entry
->counter
= counter
;
523 list_add_tail(&entry
->list
, &file
->async_file
->event_list
);
525 list_add_tail(&entry
->obj_list
, obj_list
);
526 spin_unlock_irqrestore(&file
->async_file
->lock
, flags
);
528 wake_up_interruptible(&file
->async_file
->poll_wait
);
529 kill_fasync(&file
->async_file
->async_queue
, SIGIO
, POLL_IN
);
532 void ib_uverbs_cq_event_handler(struct ib_event
*event
, void *context_ptr
)
534 struct ib_ucq_object
*uobj
= container_of(event
->element
.cq
->uobject
,
535 struct ib_ucq_object
, uobject
);
537 ib_uverbs_async_handler(uobj
->uverbs_file
, uobj
->uobject
.user_handle
,
538 event
->event
, &uobj
->async_list
,
539 &uobj
->async_events_reported
);
542 void ib_uverbs_qp_event_handler(struct ib_event
*event
, void *context_ptr
)
544 struct ib_uevent_object
*uobj
;
546 /* for XRC target qp's, check that qp is live */
547 if (!event
->element
.qp
->uobject
|| !event
->element
.qp
->uobject
->live
)
550 uobj
= container_of(event
->element
.qp
->uobject
,
551 struct ib_uevent_object
, uobject
);
553 ib_uverbs_async_handler(context_ptr
, uobj
->uobject
.user_handle
,
554 event
->event
, &uobj
->event_list
,
555 &uobj
->events_reported
);
558 void ib_uverbs_srq_event_handler(struct ib_event
*event
, void *context_ptr
)
560 struct ib_uevent_object
*uobj
;
562 uobj
= container_of(event
->element
.srq
->uobject
,
563 struct ib_uevent_object
, uobject
);
565 ib_uverbs_async_handler(context_ptr
, uobj
->uobject
.user_handle
,
566 event
->event
, &uobj
->event_list
,
567 &uobj
->events_reported
);
570 void ib_uverbs_event_handler(struct ib_event_handler
*handler
,
571 struct ib_event
*event
)
573 struct ib_uverbs_file
*file
=
574 container_of(handler
, struct ib_uverbs_file
, event_handler
);
576 ib_uverbs_async_handler(file
, event
->element
.port_num
, event
->event
,
580 void ib_uverbs_free_async_event_file(struct ib_uverbs_file
*file
)
582 kref_put(&file
->async_file
->ref
, ib_uverbs_release_event_file
);
583 file
->async_file
= NULL
;
586 struct file
*ib_uverbs_alloc_event_file(struct ib_uverbs_file
*uverbs_file
,
587 struct ib_device
*ib_dev
,
590 struct ib_uverbs_event_file
*ev_file
;
594 ev_file
= kzalloc(sizeof(*ev_file
), GFP_KERNEL
);
596 return ERR_PTR(-ENOMEM
);
598 kref_init(&ev_file
->ref
);
599 spin_lock_init(&ev_file
->lock
);
600 INIT_LIST_HEAD(&ev_file
->event_list
);
601 init_waitqueue_head(&ev_file
->poll_wait
);
602 ev_file
->uverbs_file
= uverbs_file
;
603 kref_get(&ev_file
->uverbs_file
->ref
);
604 ev_file
->async_queue
= NULL
;
605 ev_file
->is_closed
= 0;
607 filp
= anon_inode_getfile("[infinibandevent]", &uverbs_event_fops
,
612 mutex_lock(&uverbs_file
->device
->lists_mutex
);
613 list_add_tail(&ev_file
->list
,
614 &uverbs_file
->device
->uverbs_events_file_list
);
615 mutex_unlock(&uverbs_file
->device
->lists_mutex
);
618 WARN_ON(uverbs_file
->async_file
);
619 uverbs_file
->async_file
= ev_file
;
620 kref_get(&uverbs_file
->async_file
->ref
);
621 INIT_IB_EVENT_HANDLER(&uverbs_file
->event_handler
,
623 ib_uverbs_event_handler
);
624 ret
= ib_register_event_handler(&uverbs_file
->event_handler
);
628 /* At that point async file stuff was fully set */
629 ev_file
->is_async
= 1;
636 kref_put(&uverbs_file
->async_file
->ref
, ib_uverbs_release_event_file
);
637 uverbs_file
->async_file
= NULL
;
641 kref_put(&ev_file
->uverbs_file
->ref
, ib_uverbs_release_file
);
642 kref_put(&ev_file
->ref
, ib_uverbs_release_event_file
);
647 * Look up a completion event file by FD. If lookup is successful,
648 * takes a ref to the event file struct that it returns; if
649 * unsuccessful, returns NULL.
651 struct ib_uverbs_event_file
*ib_uverbs_lookup_comp_file(int fd
)
653 struct ib_uverbs_event_file
*ev_file
= NULL
;
654 struct fd f
= fdget(fd
);
659 if (f
.file
->f_op
!= &uverbs_event_fops
)
662 ev_file
= f
.file
->private_data
;
663 if (ev_file
->is_async
) {
668 kref_get(&ev_file
->ref
);
675 static ssize_t
ib_uverbs_write(struct file
*filp
, const char __user
*buf
,
676 size_t count
, loff_t
*pos
)
678 struct ib_uverbs_file
*file
= filp
->private_data
;
679 struct ib_device
*ib_dev
;
680 struct ib_uverbs_cmd_hdr hdr
;
685 if (count
< sizeof hdr
)
688 if (copy_from_user(&hdr
, buf
, sizeof hdr
))
691 srcu_key
= srcu_read_lock(&file
->device
->disassociate_srcu
);
692 ib_dev
= srcu_dereference(file
->device
->ib_dev
,
693 &file
->device
->disassociate_srcu
);
699 flags
= (hdr
.command
&
700 IB_USER_VERBS_CMD_FLAGS_MASK
) >> IB_USER_VERBS_CMD_FLAGS_SHIFT
;
705 if (hdr
.command
& ~(__u32
)(IB_USER_VERBS_CMD_FLAGS_MASK
|
706 IB_USER_VERBS_CMD_COMMAND_MASK
)) {
711 command
= hdr
.command
& IB_USER_VERBS_CMD_COMMAND_MASK
;
713 if (command
>= ARRAY_SIZE(uverbs_cmd_table
) ||
714 !uverbs_cmd_table
[command
]) {
719 if (!file
->ucontext
&&
720 command
!= IB_USER_VERBS_CMD_GET_CONTEXT
) {
725 if (!(ib_dev
->uverbs_cmd_mask
& (1ull << command
))) {
730 if (hdr
.in_words
* 4 != count
) {
735 ret
= uverbs_cmd_table
[command
](file
, ib_dev
,
740 } else if (flags
== IB_USER_VERBS_CMD_FLAG_EXTENDED
) {
743 struct ib_uverbs_ex_cmd_hdr ex_hdr
;
744 struct ib_udata ucore
;
746 size_t written_count
= count
;
748 if (hdr
.command
& ~(__u32
)(IB_USER_VERBS_CMD_FLAGS_MASK
|
749 IB_USER_VERBS_CMD_COMMAND_MASK
)) {
754 command
= hdr
.command
& IB_USER_VERBS_CMD_COMMAND_MASK
;
756 if (command
>= ARRAY_SIZE(uverbs_ex_cmd_table
) ||
757 !uverbs_ex_cmd_table
[command
]) {
762 if (!file
->ucontext
) {
767 if (!(ib_dev
->uverbs_ex_cmd_mask
& (1ull << command
))) {
772 if (count
< (sizeof(hdr
) + sizeof(ex_hdr
))) {
777 if (copy_from_user(&ex_hdr
, buf
+ sizeof(hdr
), sizeof(ex_hdr
))) {
782 count
-= sizeof(hdr
) + sizeof(ex_hdr
);
783 buf
+= sizeof(hdr
) + sizeof(ex_hdr
);
785 if ((hdr
.in_words
+ ex_hdr
.provider_in_words
) * 8 != count
) {
790 if (ex_hdr
.cmd_hdr_reserved
) {
795 if (ex_hdr
.response
) {
796 if (!hdr
.out_words
&& !ex_hdr
.provider_out_words
) {
801 if (!access_ok(VERIFY_WRITE
,
802 (void __user
*) (unsigned long) ex_hdr
.response
,
803 (hdr
.out_words
+ ex_hdr
.provider_out_words
) * 8)) {
808 if (hdr
.out_words
|| ex_hdr
.provider_out_words
) {
814 INIT_UDATA_BUF_OR_NULL(&ucore
, buf
, (unsigned long) ex_hdr
.response
,
815 hdr
.in_words
* 8, hdr
.out_words
* 8);
817 INIT_UDATA_BUF_OR_NULL(&uhw
,
819 (unsigned long) ex_hdr
.response
+ ucore
.outlen
,
820 ex_hdr
.provider_in_words
* 8,
821 ex_hdr
.provider_out_words
* 8);
823 ret
= uverbs_ex_cmd_table
[command
](file
,
834 srcu_read_unlock(&file
->device
->disassociate_srcu
, srcu_key
);
838 static int ib_uverbs_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
840 struct ib_uverbs_file
*file
= filp
->private_data
;
841 struct ib_device
*ib_dev
;
845 srcu_key
= srcu_read_lock(&file
->device
->disassociate_srcu
);
846 ib_dev
= srcu_dereference(file
->device
->ib_dev
,
847 &file
->device
->disassociate_srcu
);
856 ret
= ib_dev
->mmap(file
->ucontext
, vma
);
858 srcu_read_unlock(&file
->device
->disassociate_srcu
, srcu_key
);
863 * ib_uverbs_open() does not need the BKL:
865 * - the ib_uverbs_device structures are properly reference counted and
866 * everything else is purely local to the file being created, so
867 * races against other open calls are not a problem;
868 * - there is no ioctl method to race against;
869 * - the open method will either immediately run -ENXIO, or all
870 * required initialization will be done.
872 static int ib_uverbs_open(struct inode
*inode
, struct file
*filp
)
874 struct ib_uverbs_device
*dev
;
875 struct ib_uverbs_file
*file
;
876 struct ib_device
*ib_dev
;
878 int module_dependent
;
881 dev
= container_of(inode
->i_cdev
, struct ib_uverbs_device
, cdev
);
882 if (!atomic_inc_not_zero(&dev
->refcount
))
885 srcu_key
= srcu_read_lock(&dev
->disassociate_srcu
);
886 mutex_lock(&dev
->lists_mutex
);
887 ib_dev
= srcu_dereference(dev
->ib_dev
,
888 &dev
->disassociate_srcu
);
894 /* In case IB device supports disassociate ucontext, there is no hard
895 * dependency between uverbs device and its low level device.
897 module_dependent
= !(ib_dev
->disassociate_ucontext
);
899 if (module_dependent
) {
900 if (!try_module_get(ib_dev
->owner
)) {
906 file
= kzalloc(sizeof(*file
), GFP_KERNEL
);
909 if (module_dependent
)
916 file
->ucontext
= NULL
;
917 file
->async_file
= NULL
;
918 kref_init(&file
->ref
);
919 mutex_init(&file
->mutex
);
921 filp
->private_data
= file
;
922 kobject_get(&dev
->kobj
);
923 list_add_tail(&file
->list
, &dev
->uverbs_file_list
);
924 mutex_unlock(&dev
->lists_mutex
);
925 srcu_read_unlock(&dev
->disassociate_srcu
, srcu_key
);
927 return nonseekable_open(inode
, filp
);
930 module_put(ib_dev
->owner
);
933 mutex_unlock(&dev
->lists_mutex
);
934 srcu_read_unlock(&dev
->disassociate_srcu
, srcu_key
);
935 if (atomic_dec_and_test(&dev
->refcount
))
936 ib_uverbs_comp_dev(dev
);
941 static int ib_uverbs_close(struct inode
*inode
, struct file
*filp
)
943 struct ib_uverbs_file
*file
= filp
->private_data
;
944 struct ib_uverbs_device
*dev
= file
->device
;
945 struct ib_ucontext
*ucontext
= NULL
;
947 mutex_lock(&file
->device
->lists_mutex
);
948 ucontext
= file
->ucontext
;
949 file
->ucontext
= NULL
;
950 if (!file
->is_closed
) {
951 list_del(&file
->list
);
954 mutex_unlock(&file
->device
->lists_mutex
);
956 ib_uverbs_cleanup_ucontext(file
, ucontext
);
958 if (file
->async_file
)
959 kref_put(&file
->async_file
->ref
, ib_uverbs_release_event_file
);
961 kref_put(&file
->ref
, ib_uverbs_release_file
);
962 kobject_put(&dev
->kobj
);
967 static const struct file_operations uverbs_fops
= {
968 .owner
= THIS_MODULE
,
969 .write
= ib_uverbs_write
,
970 .open
= ib_uverbs_open
,
971 .release
= ib_uverbs_close
,
975 static const struct file_operations uverbs_mmap_fops
= {
976 .owner
= THIS_MODULE
,
977 .write
= ib_uverbs_write
,
978 .mmap
= ib_uverbs_mmap
,
979 .open
= ib_uverbs_open
,
980 .release
= ib_uverbs_close
,
984 static struct ib_client uverbs_client
= {
986 .add
= ib_uverbs_add_one
,
987 .remove
= ib_uverbs_remove_one
990 static ssize_t
show_ibdev(struct device
*device
, struct device_attribute
*attr
,
995 struct ib_uverbs_device
*dev
= dev_get_drvdata(device
);
996 struct ib_device
*ib_dev
;
1001 srcu_key
= srcu_read_lock(&dev
->disassociate_srcu
);
1002 ib_dev
= srcu_dereference(dev
->ib_dev
, &dev
->disassociate_srcu
);
1004 ret
= sprintf(buf
, "%s\n", ib_dev
->name
);
1005 srcu_read_unlock(&dev
->disassociate_srcu
, srcu_key
);
1009 static DEVICE_ATTR(ibdev
, S_IRUGO
, show_ibdev
, NULL
);
1011 static ssize_t
show_dev_abi_version(struct device
*device
,
1012 struct device_attribute
*attr
, char *buf
)
1014 struct ib_uverbs_device
*dev
= dev_get_drvdata(device
);
1017 struct ib_device
*ib_dev
;
1021 srcu_key
= srcu_read_lock(&dev
->disassociate_srcu
);
1022 ib_dev
= srcu_dereference(dev
->ib_dev
, &dev
->disassociate_srcu
);
1024 ret
= sprintf(buf
, "%d\n", ib_dev
->uverbs_abi_ver
);
1025 srcu_read_unlock(&dev
->disassociate_srcu
, srcu_key
);
1029 static DEVICE_ATTR(abi_version
, S_IRUGO
, show_dev_abi_version
, NULL
);
1031 static CLASS_ATTR_STRING(abi_version
, S_IRUGO
,
1032 __stringify(IB_USER_VERBS_ABI_VERSION
));
1034 static dev_t overflow_maj
;
1035 static DECLARE_BITMAP(overflow_map
, IB_UVERBS_MAX_DEVICES
);
1038 * If we have more than IB_UVERBS_MAX_DEVICES, dynamically overflow by
1039 * requesting a new major number and doubling the number of max devices we
1040 * support. It's stupid, but simple.
1042 static int find_overflow_devnum(void)
1046 if (!overflow_maj
) {
1047 ret
= alloc_chrdev_region(&overflow_maj
, 0, IB_UVERBS_MAX_DEVICES
,
1048 "infiniband_verbs");
1050 printk(KERN_ERR
"user_verbs: couldn't register dynamic device number\n");
1055 ret
= find_first_zero_bit(overflow_map
, IB_UVERBS_MAX_DEVICES
);
1056 if (ret
>= IB_UVERBS_MAX_DEVICES
)
1062 static void ib_uverbs_add_one(struct ib_device
*device
)
1066 struct ib_uverbs_device
*uverbs_dev
;
1069 if (!device
->alloc_ucontext
)
1072 uverbs_dev
= kzalloc(sizeof *uverbs_dev
, GFP_KERNEL
);
1076 ret
= init_srcu_struct(&uverbs_dev
->disassociate_srcu
);
1082 atomic_set(&uverbs_dev
->refcount
, 1);
1083 init_completion(&uverbs_dev
->comp
);
1084 uverbs_dev
->xrcd_tree
= RB_ROOT
;
1085 mutex_init(&uverbs_dev
->xrcd_tree_mutex
);
1086 kobject_init(&uverbs_dev
->kobj
, &ib_uverbs_dev_ktype
);
1087 mutex_init(&uverbs_dev
->lists_mutex
);
1088 INIT_LIST_HEAD(&uverbs_dev
->uverbs_file_list
);
1089 INIT_LIST_HEAD(&uverbs_dev
->uverbs_events_file_list
);
1091 spin_lock(&map_lock
);
1092 devnum
= find_first_zero_bit(dev_map
, IB_UVERBS_MAX_DEVICES
);
1093 if (devnum
>= IB_UVERBS_MAX_DEVICES
) {
1094 spin_unlock(&map_lock
);
1095 devnum
= find_overflow_devnum();
1099 spin_lock(&map_lock
);
1100 uverbs_dev
->devnum
= devnum
+ IB_UVERBS_MAX_DEVICES
;
1101 base
= devnum
+ overflow_maj
;
1102 set_bit(devnum
, overflow_map
);
1104 uverbs_dev
->devnum
= devnum
;
1105 base
= devnum
+ IB_UVERBS_BASE_DEV
;
1106 set_bit(devnum
, dev_map
);
1108 spin_unlock(&map_lock
);
1110 rcu_assign_pointer(uverbs_dev
->ib_dev
, device
);
1111 uverbs_dev
->num_comp_vectors
= device
->num_comp_vectors
;
1113 cdev_init(&uverbs_dev
->cdev
, NULL
);
1114 uverbs_dev
->cdev
.owner
= THIS_MODULE
;
1115 uverbs_dev
->cdev
.ops
= device
->mmap
? &uverbs_mmap_fops
: &uverbs_fops
;
1116 uverbs_dev
->cdev
.kobj
.parent
= &uverbs_dev
->kobj
;
1117 kobject_set_name(&uverbs_dev
->cdev
.kobj
, "uverbs%d", uverbs_dev
->devnum
);
1118 if (cdev_add(&uverbs_dev
->cdev
, base
, 1))
1121 uverbs_dev
->dev
= device_create(uverbs_class
, device
->dma_device
,
1122 uverbs_dev
->cdev
.dev
, uverbs_dev
,
1123 "uverbs%d", uverbs_dev
->devnum
);
1124 if (IS_ERR(uverbs_dev
->dev
))
1127 if (device_create_file(uverbs_dev
->dev
, &dev_attr_ibdev
))
1129 if (device_create_file(uverbs_dev
->dev
, &dev_attr_abi_version
))
1132 ib_set_client_data(device
, &uverbs_client
, uverbs_dev
);
1137 device_destroy(uverbs_class
, uverbs_dev
->cdev
.dev
);
1140 cdev_del(&uverbs_dev
->cdev
);
1141 if (uverbs_dev
->devnum
< IB_UVERBS_MAX_DEVICES
)
1142 clear_bit(devnum
, dev_map
);
1144 clear_bit(devnum
, overflow_map
);
1147 if (atomic_dec_and_test(&uverbs_dev
->refcount
))
1148 ib_uverbs_comp_dev(uverbs_dev
);
1149 wait_for_completion(&uverbs_dev
->comp
);
1150 kobject_put(&uverbs_dev
->kobj
);
1154 static void ib_uverbs_free_hw_resources(struct ib_uverbs_device
*uverbs_dev
,
1155 struct ib_device
*ib_dev
)
1157 struct ib_uverbs_file
*file
;
1158 struct ib_uverbs_event_file
*event_file
;
1159 struct ib_event event
;
1161 /* Pending running commands to terminate */
1162 synchronize_srcu(&uverbs_dev
->disassociate_srcu
);
1163 event
.event
= IB_EVENT_DEVICE_FATAL
;
1164 event
.element
.port_num
= 0;
1165 event
.device
= ib_dev
;
1167 mutex_lock(&uverbs_dev
->lists_mutex
);
1168 while (!list_empty(&uverbs_dev
->uverbs_file_list
)) {
1169 struct ib_ucontext
*ucontext
;
1171 file
= list_first_entry(&uverbs_dev
->uverbs_file_list
,
1172 struct ib_uverbs_file
, list
);
1173 file
->is_closed
= 1;
1174 ucontext
= file
->ucontext
;
1175 list_del(&file
->list
);
1176 file
->ucontext
= NULL
;
1177 kref_get(&file
->ref
);
1178 mutex_unlock(&uverbs_dev
->lists_mutex
);
1179 /* We must release the mutex before going ahead and calling
1180 * disassociate_ucontext. disassociate_ucontext might end up
1181 * indirectly calling uverbs_close, for example due to freeing
1182 * the resources (e.g mmput).
1184 ib_uverbs_event_handler(&file
->event_handler
, &event
);
1186 ib_dev
->disassociate_ucontext(ucontext
);
1187 ib_uverbs_cleanup_ucontext(file
, ucontext
);
1190 mutex_lock(&uverbs_dev
->lists_mutex
);
1191 kref_put(&file
->ref
, ib_uverbs_release_file
);
1194 while (!list_empty(&uverbs_dev
->uverbs_events_file_list
)) {
1195 event_file
= list_first_entry(&uverbs_dev
->
1196 uverbs_events_file_list
,
1197 struct ib_uverbs_event_file
,
1199 spin_lock_irq(&event_file
->lock
);
1200 event_file
->is_closed
= 1;
1201 spin_unlock_irq(&event_file
->lock
);
1203 list_del(&event_file
->list
);
1204 if (event_file
->is_async
) {
1205 ib_unregister_event_handler(&event_file
->uverbs_file
->
1207 event_file
->uverbs_file
->event_handler
.device
= NULL
;
1210 wake_up_interruptible(&event_file
->poll_wait
);
1211 kill_fasync(&event_file
->async_queue
, SIGIO
, POLL_IN
);
1213 mutex_unlock(&uverbs_dev
->lists_mutex
);
1216 static void ib_uverbs_remove_one(struct ib_device
*device
, void *client_data
)
1218 struct ib_uverbs_device
*uverbs_dev
= client_data
;
1219 int wait_clients
= 1;
1224 dev_set_drvdata(uverbs_dev
->dev
, NULL
);
1225 device_destroy(uverbs_class
, uverbs_dev
->cdev
.dev
);
1226 cdev_del(&uverbs_dev
->cdev
);
1228 if (uverbs_dev
->devnum
< IB_UVERBS_MAX_DEVICES
)
1229 clear_bit(uverbs_dev
->devnum
, dev_map
);
1231 clear_bit(uverbs_dev
->devnum
- IB_UVERBS_MAX_DEVICES
, overflow_map
);
1233 if (device
->disassociate_ucontext
) {
1234 /* We disassociate HW resources and immediately return.
1235 * Userspace will see a EIO errno for all future access.
1236 * Upon returning, ib_device may be freed internally and is not
1238 * uverbs_device is still available until all clients close
1239 * their files, then the uverbs device ref count will be zero
1240 * and its resources will be freed.
1241 * Note: At this point no more files can be opened since the
1242 * cdev was deleted, however active clients can still issue
1243 * commands and close their open files.
1245 rcu_assign_pointer(uverbs_dev
->ib_dev
, NULL
);
1246 ib_uverbs_free_hw_resources(uverbs_dev
, device
);
1250 if (atomic_dec_and_test(&uverbs_dev
->refcount
))
1251 ib_uverbs_comp_dev(uverbs_dev
);
1253 wait_for_completion(&uverbs_dev
->comp
);
1254 kobject_put(&uverbs_dev
->kobj
);
1257 static char *uverbs_devnode(struct device
*dev
, umode_t
*mode
)
1261 return kasprintf(GFP_KERNEL
, "infiniband/%s", dev_name(dev
));
1264 static int __init
ib_uverbs_init(void)
1268 ret
= register_chrdev_region(IB_UVERBS_BASE_DEV
, IB_UVERBS_MAX_DEVICES
,
1269 "infiniband_verbs");
1271 printk(KERN_ERR
"user_verbs: couldn't register device number\n");
1275 uverbs_class
= class_create(THIS_MODULE
, "infiniband_verbs");
1276 if (IS_ERR(uverbs_class
)) {
1277 ret
= PTR_ERR(uverbs_class
);
1278 printk(KERN_ERR
"user_verbs: couldn't create class infiniband_verbs\n");
1282 uverbs_class
->devnode
= uverbs_devnode
;
1284 ret
= class_create_file(uverbs_class
, &class_attr_abi_version
.attr
);
1286 printk(KERN_ERR
"user_verbs: couldn't create abi_version attribute\n");
1290 ret
= ib_register_client(&uverbs_client
);
1292 printk(KERN_ERR
"user_verbs: couldn't register client\n");
1299 class_destroy(uverbs_class
);
1302 unregister_chrdev_region(IB_UVERBS_BASE_DEV
, IB_UVERBS_MAX_DEVICES
);
1308 static void __exit
ib_uverbs_cleanup(void)
1310 ib_unregister_client(&uverbs_client
);
1311 class_destroy(uverbs_class
);
1312 unregister_chrdev_region(IB_UVERBS_BASE_DEV
, IB_UVERBS_MAX_DEVICES
);
1314 unregister_chrdev_region(overflow_maj
, IB_UVERBS_MAX_DEVICES
);
1315 idr_destroy(&ib_uverbs_pd_idr
);
1316 idr_destroy(&ib_uverbs_mr_idr
);
1317 idr_destroy(&ib_uverbs_mw_idr
);
1318 idr_destroy(&ib_uverbs_ah_idr
);
1319 idr_destroy(&ib_uverbs_cq_idr
);
1320 idr_destroy(&ib_uverbs_qp_idr
);
1321 idr_destroy(&ib_uverbs_srq_idr
);
1324 module_init(ib_uverbs_init
);
1325 module_exit(ib_uverbs_cleanup
);