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
))) {
123 * This will cause send_complete() to be called in
126 spin_lock(&cq
->rdi
->n_cqs_lock
);
127 if (likely(cq
->rdi
->worker
)) {
128 cq
->notify
= RVT_CQ_NONE
;
130 kthread_queue_work(cq
->rdi
->worker
, &cq
->comptask
);
132 spin_unlock(&cq
->rdi
->n_cqs_lock
);
135 spin_unlock_irqrestore(&cq
->lock
, flags
);
137 EXPORT_SYMBOL(rvt_cq_enter
);
139 static void send_complete(struct kthread_work
*work
)
141 struct rvt_cq
*cq
= container_of(work
, struct rvt_cq
, comptask
);
144 * The completion handler will most likely rearm the notification
145 * and poll for all pending entries. If a new completion entry
146 * is added while we are in this routine, queue_work()
147 * won't call us again until we return so we check triggered to
148 * see if we need to call the handler again.
151 u8 triggered
= cq
->triggered
;
154 * IPoIB connected mode assumes the callback is from a
155 * soft IRQ. We simulate this by blocking "bottom halves".
156 * See the implementation for ipoib_cm_handle_tx_wc(),
157 * netif_tx_lock_bh() and netif_tx_lock().
160 cq
->ibcq
.comp_handler(&cq
->ibcq
, cq
->ibcq
.cq_context
);
163 if (cq
->triggered
== triggered
)
169 * rvt_create_cq - create a completion queue
170 * @ibdev: the device this completion queue is attached to
171 * @attr: creation attributes
172 * @context: unused by the QLogic_IB driver
173 * @udata: user data for libibverbs.so
175 * Called by ib_create_cq() in the generic verbs code.
177 * Return: pointer to the completion queue or negative errno values
180 struct ib_cq
*rvt_create_cq(struct ib_device
*ibdev
,
181 const struct ib_cq_init_attr
*attr
,
182 struct ib_ucontext
*context
,
183 struct ib_udata
*udata
)
185 struct rvt_dev_info
*rdi
= ib_to_rvt(ibdev
);
187 struct rvt_cq_wc
*wc
;
190 unsigned int entries
= attr
->cqe
;
193 return ERR_PTR(-EINVAL
);
195 if (entries
< 1 || entries
> rdi
->dparms
.props
.max_cqe
)
196 return ERR_PTR(-EINVAL
);
198 /* Allocate the completion queue structure. */
199 cq
= kzalloc(sizeof(*cq
), GFP_KERNEL
);
201 return ERR_PTR(-ENOMEM
);
204 * Allocate the completion queue entries and head/tail pointers.
205 * This is allocated separately so that it can be resized and
206 * also mapped into user space.
207 * We need to use vmalloc() in order to support mmap and large
208 * numbers of entries.
211 if (udata
&& udata
->outlen
>= sizeof(__u64
))
212 sz
+= sizeof(struct ib_uverbs_wc
) * (entries
+ 1);
214 sz
+= sizeof(struct ib_wc
) * (entries
+ 1);
215 wc
= vmalloc_user(sz
);
217 ret
= ERR_PTR(-ENOMEM
);
222 * Return the address of the WC as the offset to mmap.
223 * See rvt_mmap() for details.
225 if (udata
&& udata
->outlen
>= sizeof(__u64
)) {
228 cq
->ip
= rvt_create_mmap_info(rdi
, sz
, context
, wc
);
230 ret
= ERR_PTR(-ENOMEM
);
234 err
= ib_copy_to_udata(udata
, &cq
->ip
->offset
,
235 sizeof(cq
->ip
->offset
));
242 spin_lock_irq(&rdi
->n_cqs_lock
);
243 if (rdi
->n_cqs_allocated
== rdi
->dparms
.props
.max_cq
) {
244 spin_unlock_irq(&rdi
->n_cqs_lock
);
245 ret
= ERR_PTR(-ENOMEM
);
249 rdi
->n_cqs_allocated
++;
250 spin_unlock_irq(&rdi
->n_cqs_lock
);
253 spin_lock_irq(&rdi
->pending_lock
);
254 list_add(&cq
->ip
->pending_mmaps
, &rdi
->pending_mmaps
);
255 spin_unlock_irq(&rdi
->pending_lock
);
259 * ib_create_cq() will initialize cq->ibcq except for cq->ibcq.cqe.
260 * The number of entries should be >= the number requested or return
264 cq
->ibcq
.cqe
= entries
;
265 cq
->notify
= RVT_CQ_NONE
;
266 spin_lock_init(&cq
->lock
);
267 kthread_init_work(&cq
->comptask
, send_complete
);
285 * rvt_destroy_cq - destroy a completion queue
286 * @ibcq: the completion queue to destroy.
288 * Called by ib_destroy_cq() in the generic verbs code.
292 int rvt_destroy_cq(struct ib_cq
*ibcq
)
294 struct rvt_cq
*cq
= ibcq_to_rvtcq(ibcq
);
295 struct rvt_dev_info
*rdi
= cq
->rdi
;
297 kthread_flush_work(&cq
->comptask
);
298 spin_lock_irq(&rdi
->n_cqs_lock
);
299 rdi
->n_cqs_allocated
--;
300 spin_unlock_irq(&rdi
->n_cqs_lock
);
302 kref_put(&cq
->ip
->ref
, rvt_release_mmap_info
);
311 * rvt_req_notify_cq - change the notification type for a completion queue
312 * @ibcq: the completion queue
313 * @notify_flags: the type of notification to request
315 * This may be called from interrupt context. Also called by
316 * ib_req_notify_cq() in the generic verbs code.
318 * Return: 0 for success.
320 int rvt_req_notify_cq(struct ib_cq
*ibcq
, enum ib_cq_notify_flags notify_flags
)
322 struct rvt_cq
*cq
= ibcq_to_rvtcq(ibcq
);
326 spin_lock_irqsave(&cq
->lock
, flags
);
328 * Don't change IB_CQ_NEXT_COMP to IB_CQ_SOLICITED but allow
329 * any other transitions (see C11-31 and C11-32 in ch. 11.4.2.2).
331 if (cq
->notify
!= IB_CQ_NEXT_COMP
)
332 cq
->notify
= notify_flags
& IB_CQ_SOLICITED_MASK
;
334 if ((notify_flags
& IB_CQ_REPORT_MISSED_EVENTS
) &&
335 cq
->queue
->head
!= cq
->queue
->tail
)
338 spin_unlock_irqrestore(&cq
->lock
, flags
);
344 * rvt_resize_cq - change the size of the CQ
345 * @ibcq: the completion queue
347 * Return: 0 for success.
349 int rvt_resize_cq(struct ib_cq
*ibcq
, int cqe
, struct ib_udata
*udata
)
351 struct rvt_cq
*cq
= ibcq_to_rvtcq(ibcq
);
352 struct rvt_cq_wc
*old_wc
;
353 struct rvt_cq_wc
*wc
;
357 struct rvt_dev_info
*rdi
= cq
->rdi
;
359 if (cqe
< 1 || cqe
> rdi
->dparms
.props
.max_cqe
)
363 * Need to use vmalloc() if we want to support large #s of entries.
366 if (udata
&& udata
->outlen
>= sizeof(__u64
))
367 sz
+= sizeof(struct ib_uverbs_wc
) * (cqe
+ 1);
369 sz
+= sizeof(struct ib_wc
) * (cqe
+ 1);
370 wc
= vmalloc_user(sz
);
374 /* Check that we can write the offset to mmap. */
375 if (udata
&& udata
->outlen
>= sizeof(__u64
)) {
378 ret
= ib_copy_to_udata(udata
, &offset
, sizeof(offset
));
383 spin_lock_irq(&cq
->lock
);
385 * Make sure head and tail are sane since they
386 * might be user writable.
390 if (head
> (u32
)cq
->ibcq
.cqe
)
391 head
= (u32
)cq
->ibcq
.cqe
;
393 if (tail
> (u32
)cq
->ibcq
.cqe
)
394 tail
= (u32
)cq
->ibcq
.cqe
;
396 n
= cq
->ibcq
.cqe
+ 1 + head
- tail
;
399 if (unlikely((u32
)cqe
< n
)) {
403 for (n
= 0; tail
!= head
; n
++) {
405 wc
->uqueue
[n
] = old_wc
->uqueue
[tail
];
407 wc
->kqueue
[n
] = old_wc
->kqueue
[tail
];
408 if (tail
== (u32
)cq
->ibcq
.cqe
)
417 spin_unlock_irq(&cq
->lock
);
422 struct rvt_mmap_info
*ip
= cq
->ip
;
424 rvt_update_mmap_info(rdi
, ip
, sz
, wc
);
427 * Return the offset to mmap.
428 * See rvt_mmap() for details.
430 if (udata
&& udata
->outlen
>= sizeof(__u64
)) {
431 ret
= ib_copy_to_udata(udata
, &ip
->offset
,
437 spin_lock_irq(&rdi
->pending_lock
);
438 if (list_empty(&ip
->pending_mmaps
))
439 list_add(&ip
->pending_mmaps
, &rdi
->pending_mmaps
);
440 spin_unlock_irq(&rdi
->pending_lock
);
446 spin_unlock_irq(&cq
->lock
);
453 * rvt_poll_cq - poll for work completion entries
454 * @ibcq: the completion queue to poll
455 * @num_entries: the maximum number of entries to return
456 * @entry: pointer to array where work completions are placed
458 * This may be called from interrupt context. Also called by ib_poll_cq()
459 * in the generic verbs code.
461 * Return: the number of completion entries polled.
463 int rvt_poll_cq(struct ib_cq
*ibcq
, int num_entries
, struct ib_wc
*entry
)
465 struct rvt_cq
*cq
= ibcq_to_rvtcq(ibcq
);
466 struct rvt_cq_wc
*wc
;
471 /* The kernel can only poll a kernel completion queue */
475 spin_lock_irqsave(&cq
->lock
, flags
);
479 if (tail
> (u32
)cq
->ibcq
.cqe
)
480 tail
= (u32
)cq
->ibcq
.cqe
;
481 for (npolled
= 0; npolled
< num_entries
; ++npolled
, ++entry
) {
482 if (tail
== wc
->head
)
484 /* The kernel doesn't need a RMB since it has the lock. */
485 *entry
= wc
->kqueue
[tail
];
486 if (tail
>= cq
->ibcq
.cqe
)
493 spin_unlock_irqrestore(&cq
->lock
, flags
);
499 * rvt_driver_cq_init - Init cq resources on behalf of driver
500 * @rdi: rvt dev structure
502 * Return: 0 on success
504 int rvt_driver_cq_init(struct rvt_dev_info
*rdi
)
507 struct kthread_worker
*worker
;
512 spin_lock_init(&rdi
->n_cqs_lock
);
514 cpu
= cpumask_first(cpumask_of_node(rdi
->dparms
.node
));
515 worker
= kthread_create_worker_on_cpu(cpu
, 0,
516 "%s", rdi
->dparms
.cq_name
);
518 return PTR_ERR(worker
);
520 set_user_nice(worker
->task
, MIN_NICE
);
521 rdi
->worker
= worker
;
526 * rvt_cq_exit - tear down cq reources
527 * @rdi: rvt dev structure
529 void rvt_cq_exit(struct rvt_dev_info
*rdi
)
531 struct kthread_worker
*worker
;
533 /* block future queuing from send_complete() */
534 spin_lock_irq(&rdi
->n_cqs_lock
);
535 worker
= rdi
->worker
;
537 spin_unlock_irq(&rdi
->n_cqs_lock
);
541 spin_unlock_irq(&rdi
->n_cqs_lock
);
543 kthread_destroy_worker(worker
);