2 * Copyright(c) 2016 Intel Corporation.
4 * This file is provided under a dual BSD/GPLv2 license. When using or
5 * redistributing this file, you may do so under either license.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2 of the GNU General Public License as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
20 * Redistribution and use in source and binary forms, with or without
21 * modification, are permitted provided that the following conditions
24 * - Redistributions of source code must retain the above copyright
25 * notice, this list of conditions and the following disclaimer.
26 * - Redistributions in binary form must reproduce the above copyright
27 * notice, this list of conditions and the following disclaimer in
28 * the documentation and/or other materials provided with the
30 * - Neither the name of Intel Corporation nor the names of its
31 * contributors may be used to endorse or promote products derived
32 * from this software without specific prior written permission.
34 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
35 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
36 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
37 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
38 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
39 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
40 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
41 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
42 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
43 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
44 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48 #include <linux/slab.h>
49 #include <linux/vmalloc.h>
50 #include <linux/kthread.h>
55 * rvt_cq_enter - add a new entry to the completion queue
56 * @cq: completion queue
57 * @entry: work completion entry to add
58 * @sig: true if @entry is solicited
60 * This may be called with qp->s_lock held.
62 void rvt_cq_enter(struct rvt_cq
*cq
, struct ib_wc
*entry
, bool solicited
)
69 spin_lock_irqsave(&cq
->lock
, flags
);
72 * Note that the head pointer might be writable by user processes.
73 * Take care to verify it is a sane value.
77 if (head
>= (unsigned)cq
->ibcq
.cqe
) {
84 if (unlikely(next
== wc
->tail
)) {
85 spin_unlock_irqrestore(&cq
->lock
, flags
);
86 if (cq
->ibcq
.event_handler
) {
89 ev
.device
= cq
->ibcq
.device
;
90 ev
.element
.cq
= &cq
->ibcq
;
91 ev
.event
= IB_EVENT_CQ_ERR
;
92 cq
->ibcq
.event_handler(&ev
, cq
->ibcq
.cq_context
);
97 wc
->uqueue
[head
].wr_id
= entry
->wr_id
;
98 wc
->uqueue
[head
].status
= entry
->status
;
99 wc
->uqueue
[head
].opcode
= entry
->opcode
;
100 wc
->uqueue
[head
].vendor_err
= entry
->vendor_err
;
101 wc
->uqueue
[head
].byte_len
= entry
->byte_len
;
102 wc
->uqueue
[head
].ex
.imm_data
=
103 (__u32 __force
)entry
->ex
.imm_data
;
104 wc
->uqueue
[head
].qp_num
= entry
->qp
->qp_num
;
105 wc
->uqueue
[head
].src_qp
= entry
->src_qp
;
106 wc
->uqueue
[head
].wc_flags
= entry
->wc_flags
;
107 wc
->uqueue
[head
].pkey_index
= entry
->pkey_index
;
108 wc
->uqueue
[head
].slid
= entry
->slid
;
109 wc
->uqueue
[head
].sl
= entry
->sl
;
110 wc
->uqueue
[head
].dlid_path_bits
= entry
->dlid_path_bits
;
111 wc
->uqueue
[head
].port_num
= entry
->port_num
;
112 /* Make sure entry is written before the head index. */
115 wc
->kqueue
[head
] = *entry
;
119 if (cq
->notify
== IB_CQ_NEXT_COMP
||
120 (cq
->notify
== IB_CQ_SOLICITED
&&
121 (solicited
|| entry
->status
!= IB_WC_SUCCESS
))) {
122 struct kthread_worker
*worker
;
124 * This will cause send_complete() to be called in
127 smp_read_barrier_depends(); /* see rvt_cq_exit */
128 worker
= cq
->rdi
->worker
;
129 if (likely(worker
)) {
130 cq
->notify
= RVT_CQ_NONE
;
132 kthread_queue_work(worker
, &cq
->comptask
);
136 spin_unlock_irqrestore(&cq
->lock
, flags
);
138 EXPORT_SYMBOL(rvt_cq_enter
);
140 static void send_complete(struct kthread_work
*work
)
142 struct rvt_cq
*cq
= container_of(work
, struct rvt_cq
, comptask
);
145 * The completion handler will most likely rearm the notification
146 * and poll for all pending entries. If a new completion entry
147 * is added while we are in this routine, queue_work()
148 * won't call us again until we return so we check triggered to
149 * see if we need to call the handler again.
152 u8 triggered
= cq
->triggered
;
155 * IPoIB connected mode assumes the callback is from a
156 * soft IRQ. We simulate this by blocking "bottom halves".
157 * See the implementation for ipoib_cm_handle_tx_wc(),
158 * netif_tx_lock_bh() and netif_tx_lock().
161 cq
->ibcq
.comp_handler(&cq
->ibcq
, cq
->ibcq
.cq_context
);
164 if (cq
->triggered
== triggered
)
170 * rvt_create_cq - create a completion queue
171 * @ibdev: the device this completion queue is attached to
172 * @attr: creation attributes
173 * @context: unused by the QLogic_IB driver
174 * @udata: user data for libibverbs.so
176 * Called by ib_create_cq() in the generic verbs code.
178 * Return: pointer to the completion queue or negative errno values
181 struct ib_cq
*rvt_create_cq(struct ib_device
*ibdev
,
182 const struct ib_cq_init_attr
*attr
,
183 struct ib_ucontext
*context
,
184 struct ib_udata
*udata
)
186 struct rvt_dev_info
*rdi
= ib_to_rvt(ibdev
);
188 struct rvt_cq_wc
*wc
;
191 unsigned int entries
= attr
->cqe
;
194 return ERR_PTR(-EINVAL
);
196 if (entries
< 1 || entries
> rdi
->dparms
.props
.max_cqe
)
197 return ERR_PTR(-EINVAL
);
199 /* Allocate the completion queue structure. */
200 cq
= kzalloc(sizeof(*cq
), GFP_KERNEL
);
202 return ERR_PTR(-ENOMEM
);
205 * Allocate the completion queue entries and head/tail pointers.
206 * This is allocated separately so that it can be resized and
207 * also mapped into user space.
208 * We need to use vmalloc() in order to support mmap and large
209 * numbers of entries.
212 if (udata
&& udata
->outlen
>= sizeof(__u64
))
213 sz
+= sizeof(struct ib_uverbs_wc
) * (entries
+ 1);
215 sz
+= sizeof(struct ib_wc
) * (entries
+ 1);
216 wc
= vmalloc_user(sz
);
218 ret
= ERR_PTR(-ENOMEM
);
223 * Return the address of the WC as the offset to mmap.
224 * See rvt_mmap() for details.
226 if (udata
&& udata
->outlen
>= sizeof(__u64
)) {
229 cq
->ip
= rvt_create_mmap_info(rdi
, sz
, context
, wc
);
231 ret
= ERR_PTR(-ENOMEM
);
235 err
= ib_copy_to_udata(udata
, &cq
->ip
->offset
,
236 sizeof(cq
->ip
->offset
));
243 spin_lock(&rdi
->n_cqs_lock
);
244 if (rdi
->n_cqs_allocated
== rdi
->dparms
.props
.max_cq
) {
245 spin_unlock(&rdi
->n_cqs_lock
);
246 ret
= ERR_PTR(-ENOMEM
);
250 rdi
->n_cqs_allocated
++;
251 spin_unlock(&rdi
->n_cqs_lock
);
254 spin_lock_irq(&rdi
->pending_lock
);
255 list_add(&cq
->ip
->pending_mmaps
, &rdi
->pending_mmaps
);
256 spin_unlock_irq(&rdi
->pending_lock
);
260 * ib_create_cq() will initialize cq->ibcq except for cq->ibcq.cqe.
261 * The number of entries should be >= the number requested or return
265 cq
->ibcq
.cqe
= entries
;
266 cq
->notify
= RVT_CQ_NONE
;
267 spin_lock_init(&cq
->lock
);
268 kthread_init_work(&cq
->comptask
, send_complete
);
286 * rvt_destroy_cq - destroy a completion queue
287 * @ibcq: the completion queue to destroy.
289 * Called by ib_destroy_cq() in the generic verbs code.
293 int rvt_destroy_cq(struct ib_cq
*ibcq
)
295 struct rvt_cq
*cq
= ibcq_to_rvtcq(ibcq
);
296 struct rvt_dev_info
*rdi
= cq
->rdi
;
298 kthread_flush_work(&cq
->comptask
);
299 spin_lock(&rdi
->n_cqs_lock
);
300 rdi
->n_cqs_allocated
--;
301 spin_unlock(&rdi
->n_cqs_lock
);
303 kref_put(&cq
->ip
->ref
, rvt_release_mmap_info
);
312 * rvt_req_notify_cq - change the notification type for a completion queue
313 * @ibcq: the completion queue
314 * @notify_flags: the type of notification to request
316 * This may be called from interrupt context. Also called by
317 * ib_req_notify_cq() in the generic verbs code.
319 * Return: 0 for success.
321 int rvt_req_notify_cq(struct ib_cq
*ibcq
, enum ib_cq_notify_flags notify_flags
)
323 struct rvt_cq
*cq
= ibcq_to_rvtcq(ibcq
);
327 spin_lock_irqsave(&cq
->lock
, flags
);
329 * Don't change IB_CQ_NEXT_COMP to IB_CQ_SOLICITED but allow
330 * any other transitions (see C11-31 and C11-32 in ch. 11.4.2.2).
332 if (cq
->notify
!= IB_CQ_NEXT_COMP
)
333 cq
->notify
= notify_flags
& IB_CQ_SOLICITED_MASK
;
335 if ((notify_flags
& IB_CQ_REPORT_MISSED_EVENTS
) &&
336 cq
->queue
->head
!= cq
->queue
->tail
)
339 spin_unlock_irqrestore(&cq
->lock
, flags
);
345 * rvt_resize_cq - change the size of the CQ
346 * @ibcq: the completion queue
348 * Return: 0 for success.
350 int rvt_resize_cq(struct ib_cq
*ibcq
, int cqe
, struct ib_udata
*udata
)
352 struct rvt_cq
*cq
= ibcq_to_rvtcq(ibcq
);
353 struct rvt_cq_wc
*old_wc
;
354 struct rvt_cq_wc
*wc
;
358 struct rvt_dev_info
*rdi
= cq
->rdi
;
360 if (cqe
< 1 || cqe
> rdi
->dparms
.props
.max_cqe
)
364 * Need to use vmalloc() if we want to support large #s of entries.
367 if (udata
&& udata
->outlen
>= sizeof(__u64
))
368 sz
+= sizeof(struct ib_uverbs_wc
) * (cqe
+ 1);
370 sz
+= sizeof(struct ib_wc
) * (cqe
+ 1);
371 wc
= vmalloc_user(sz
);
375 /* Check that we can write the offset to mmap. */
376 if (udata
&& udata
->outlen
>= sizeof(__u64
)) {
379 ret
= ib_copy_to_udata(udata
, &offset
, sizeof(offset
));
384 spin_lock_irq(&cq
->lock
);
386 * Make sure head and tail are sane since they
387 * might be user writable.
391 if (head
> (u32
)cq
->ibcq
.cqe
)
392 head
= (u32
)cq
->ibcq
.cqe
;
394 if (tail
> (u32
)cq
->ibcq
.cqe
)
395 tail
= (u32
)cq
->ibcq
.cqe
;
397 n
= cq
->ibcq
.cqe
+ 1 + head
- tail
;
400 if (unlikely((u32
)cqe
< n
)) {
404 for (n
= 0; tail
!= head
; n
++) {
406 wc
->uqueue
[n
] = old_wc
->uqueue
[tail
];
408 wc
->kqueue
[n
] = old_wc
->kqueue
[tail
];
409 if (tail
== (u32
)cq
->ibcq
.cqe
)
418 spin_unlock_irq(&cq
->lock
);
423 struct rvt_mmap_info
*ip
= cq
->ip
;
425 rvt_update_mmap_info(rdi
, ip
, sz
, wc
);
428 * Return the offset to mmap.
429 * See rvt_mmap() for details.
431 if (udata
&& udata
->outlen
>= sizeof(__u64
)) {
432 ret
= ib_copy_to_udata(udata
, &ip
->offset
,
438 spin_lock_irq(&rdi
->pending_lock
);
439 if (list_empty(&ip
->pending_mmaps
))
440 list_add(&ip
->pending_mmaps
, &rdi
->pending_mmaps
);
441 spin_unlock_irq(&rdi
->pending_lock
);
447 spin_unlock_irq(&cq
->lock
);
454 * rvt_poll_cq - poll for work completion entries
455 * @ibcq: the completion queue to poll
456 * @num_entries: the maximum number of entries to return
457 * @entry: pointer to array where work completions are placed
459 * This may be called from interrupt context. Also called by ib_poll_cq()
460 * in the generic verbs code.
462 * Return: the number of completion entries polled.
464 int rvt_poll_cq(struct ib_cq
*ibcq
, int num_entries
, struct ib_wc
*entry
)
466 struct rvt_cq
*cq
= ibcq_to_rvtcq(ibcq
);
467 struct rvt_cq_wc
*wc
;
472 /* The kernel can only poll a kernel completion queue */
476 spin_lock_irqsave(&cq
->lock
, flags
);
480 if (tail
> (u32
)cq
->ibcq
.cqe
)
481 tail
= (u32
)cq
->ibcq
.cqe
;
482 for (npolled
= 0; npolled
< num_entries
; ++npolled
, ++entry
) {
483 if (tail
== wc
->head
)
485 /* The kernel doesn't need a RMB since it has the lock. */
486 *entry
= wc
->kqueue
[tail
];
487 if (tail
>= cq
->ibcq
.cqe
)
494 spin_unlock_irqrestore(&cq
->lock
, flags
);
500 * rvt_driver_cq_init - Init cq resources on behalf of driver
501 * @rdi: rvt dev structure
503 * Return: 0 on success
505 int rvt_driver_cq_init(struct rvt_dev_info
*rdi
)
509 struct task_struct
*task
;
513 spin_lock_init(&rdi
->n_cqs_lock
);
514 rdi
->worker
= kzalloc(sizeof(*rdi
->worker
), GFP_KERNEL
);
517 kthread_init_worker(rdi
->worker
);
518 task
= kthread_create_on_node(
522 "%s", rdi
->dparms
.cq_name
);
526 return PTR_ERR(task
);
529 set_user_nice(task
, MIN_NICE
);
530 cpu
= cpumask_first(cpumask_of_node(rdi
->dparms
.node
));
531 kthread_bind(task
, cpu
);
532 wake_up_process(task
);
537 * rvt_cq_exit - tear down cq reources
538 * @rdi: rvt dev structure
540 void rvt_cq_exit(struct rvt_dev_info
*rdi
)
542 struct kthread_worker
*worker
;
544 worker
= rdi
->worker
;
547 /* blocks future queuing from send_complete() */
549 smp_wmb(); /* See rdi_cq_enter */
550 kthread_flush_worker(worker
);
551 kthread_stop(worker
->task
);