2 * This file is provided under a dual BSD/GPLv2 license. When using or
3 * redistributing this file, you may do so under either license.
7 * Copyright(c) 2015 Intel Corporation. All rights reserved.
8 * Copyright(c) 2017 T-Platforms. All Rights Reserved.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of version 2 of the GNU General Public License as
12 * published by the Free Software Foundation.
16 * Copyright(c) 2015 Intel Corporation. All rights reserved.
17 * Copyright(c) 2017 T-Platforms. All Rights Reserved.
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
23 * * Redistributions of source code must retain the above copyright
24 * notice, this list of conditions and the following disclaimer.
25 * * Redistributions in binary form must reproduce the above copy
26 * notice, this list of conditions and the following disclaimer in
27 * the documentation and/or other materials provided with the
29 * * Neither the name of Intel Corporation nor the names of its
30 * contributors may be used to endorse or promote products derived
31 * from this software without specific prior written permission.
33 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
34 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
35 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
36 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
37 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
39 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
40 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
41 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
43 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45 * PCIe NTB Perf Linux driver
49 * How to use this tool, by example.
51 * Assuming $DBG_DIR is something like:
52 * '/sys/kernel/debug/ntb_perf/0000:00:03.0'
53 * Suppose aside from local device there is at least one remote device
54 * connected to NTB with index 0.
55 *-----------------------------------------------------------------------------
56 * Eg: install driver with specified chunk/total orders and dma-enabled flag
58 * root@self# insmod ntb_perf.ko chunk_order=19 total_order=28 use_dma
59 *-----------------------------------------------------------------------------
60 * Eg: check NTB ports (index) and MW mapping information
62 * root@self# cat $DBG_DIR/info
63 *-----------------------------------------------------------------------------
64 * Eg: start performance test with peer (index 0) and get the test metrics
66 * root@self# echo 0 > $DBG_DIR/run
67 * root@self# cat $DBG_DIR/run
70 #include <linux/init.h>
71 #include <linux/kernel.h>
72 #include <linux/module.h>
73 #include <linux/sched.h>
74 #include <linux/wait.h>
75 #include <linux/dma-mapping.h>
76 #include <linux/dmaengine.h>
77 #include <linux/pci.h>
78 #include <linux/ktime.h>
79 #include <linux/slab.h>
80 #include <linux/delay.h>
81 #include <linux/sizes.h>
82 #include <linux/workqueue.h>
83 #include <linux/debugfs.h>
84 #include <linux/random.h>
85 #include <linux/ntb.h>
87 #define DRIVER_NAME "ntb_perf"
88 #define DRIVER_VERSION "2.0"
90 MODULE_LICENSE("Dual BSD/GPL");
91 MODULE_VERSION(DRIVER_VERSION);
93 MODULE_DESCRIPTION("PCIe NTB Performance Measurement Tool");
95 #define MAX_THREADS_CNT 32
96 #define DEF_THREADS_CNT 1
97 #define MAX_CHUNK_SIZE SZ_1M
98 #define MAX_CHUNK_ORDER 20 /* no larger than 1M */
100 #define DMA_TRIES 100
101 #define DMA_MDELAY 10
103 #define MSG_TRIES 1000
104 #define MSG_UDELAY_LOW 1000000
105 #define MSG_UDELAY_HIGH 2000000
107 #define PERF_BUF_LEN 1024
109 static unsigned long max_mw_size;
110 module_param(max_mw_size, ulong, 0644);
111 MODULE_PARM_DESC(max_mw_size, "Upper limit of memory window size");
113 static unsigned char chunk_order = 19; /* 512K */
114 module_param(chunk_order, byte, 0644);
115 MODULE_PARM_DESC(chunk_order, "Data chunk order [2^n] to transfer");
117 static unsigned char total_order = 30; /* 1G */
118 module_param(total_order, byte, 0644);
119 MODULE_PARM_DESC(total_order, "Total data order [2^n] to transfer");
121 static bool use_dma; /* default to 0 */
122 module_param(use_dma, bool, 0644);
123 MODULE_PARM_DESC(use_dma, "Use DMA engine to measure performance");
125 /*==============================================================================
126 * Perf driver data definition
127 *==============================================================================
131 PERF_CMD_INVAL = -1,/* invalid spad command */
132 PERF_CMD_SSIZE = 0, /* send out buffer size */
133 PERF_CMD_RSIZE = 1, /* recv in buffer size */
134 PERF_CMD_SXLAT = 2, /* send in buffer xlat */
135 PERF_CMD_RXLAT = 3, /* recv out buffer xlat */
136 PERF_CMD_CLEAR = 4, /* clear allocated memory */
137 PERF_STS_DONE = 5, /* init is done */
138 PERF_STS_LNKUP = 6, /* link up state flag */
144 struct perf_ctx *perf;
148 /* Outbound MW params */
150 resource_size_t outbuf_size;
151 void __iomem *outbuf;
152 phys_addr_t out_phys_addr;
153 dma_addr_t dma_dst_addr;
154 /* Inbound MW params */
155 dma_addr_t inbuf_xlat;
156 resource_size_t inbuf_size;
159 /* NTB connection setup service */
160 struct work_struct service;
163 struct completion init_comp;
165 #define to_peer_service(__work) \
166 container_of(__work, struct perf_peer, service)
169 struct perf_ctx *perf;
172 /* DMA-based test sync parameters */
174 wait_queue_head_t dma_wait;
175 struct dma_chan *dma_chan;
177 /* Data source and measured statistics */
182 struct work_struct work;
184 #define to_thread_work(__work) \
185 container_of(__work, struct perf_thread, work)
190 /* Global device index and peers descriptors */
193 struct perf_peer *peers;
195 /* Performance measuring work-threads interface */
196 unsigned long busy_flag;
197 wait_queue_head_t twait;
200 struct perf_peer *test_peer;
201 struct perf_thread threads[MAX_THREADS_CNT];
203 /* Scratchpad/Message IO operations */
204 int (*cmd_send)(struct perf_peer *peer, enum perf_cmd cmd, u64 data);
205 int (*cmd_recv)(struct perf_ctx *perf, int *pidx, enum perf_cmd *cmd,
208 struct dentry *dbgfs_dir;
212 * Scratchpads-base commands interface
214 #define PERF_SPAD_CNT(_pcnt) \
216 #define PERF_SPAD_CMD(_gidx) \
218 #define PERF_SPAD_LDATA(_gidx) \
220 #define PERF_SPAD_HDATA(_gidx) \
222 #define PERF_SPAD_NOTIFY(_gidx) \
226 * Messages-base commands interface
228 #define PERF_MSG_CNT 3
229 #define PERF_MSG_CMD 0
230 #define PERF_MSG_LDATA 1
231 #define PERF_MSG_HDATA 2
233 /*==============================================================================
234 * Static data declarations
235 *==============================================================================
238 static struct dentry *perf_dbgfs_topdir;
240 static struct workqueue_struct *perf_wq __read_mostly;
242 /*==============================================================================
243 * NTB cross-link commands execution service
244 *==============================================================================
247 static void perf_terminate_test(struct perf_ctx *perf);
249 static inline bool perf_link_is_up(struct perf_peer *peer)
253 link = ntb_link_is_up(peer->perf->ntb, NULL, NULL);
254 return !!(link & BIT_ULL_MASK(peer->pidx));
257 static int perf_spad_cmd_send(struct perf_peer *peer, enum perf_cmd cmd,
260 struct perf_ctx *perf = peer->perf;
264 dev_dbg(&perf->ntb->dev, "CMD send: %d 0x%llx\n", cmd, data);
267 * Perform predefined number of attempts before give up.
268 * We are sending the data to the port specific scratchpad, so
269 * to prevent a multi-port access race-condition. Additionally
270 * there is no need in local locking since only thread-safe
271 * service work is using this method.
273 for (try = 0; try < MSG_TRIES; try++) {
274 if (!perf_link_is_up(peer))
277 sts = ntb_peer_spad_read(perf->ntb, peer->pidx,
278 PERF_SPAD_CMD(perf->gidx));
279 if (sts != PERF_CMD_INVAL) {
280 usleep_range(MSG_UDELAY_LOW, MSG_UDELAY_HIGH);
284 ntb_peer_spad_write(perf->ntb, peer->pidx,
285 PERF_SPAD_LDATA(perf->gidx),
286 lower_32_bits(data));
287 ntb_peer_spad_write(perf->ntb, peer->pidx,
288 PERF_SPAD_HDATA(perf->gidx),
289 upper_32_bits(data));
290 ntb_peer_spad_write(perf->ntb, peer->pidx,
291 PERF_SPAD_CMD(perf->gidx),
293 ntb_peer_db_set(perf->ntb, PERF_SPAD_NOTIFY(peer->gidx));
295 dev_dbg(&perf->ntb->dev, "DB ring peer %#llx\n",
296 PERF_SPAD_NOTIFY(peer->gidx));
301 return try < MSG_TRIES ? 0 : -EAGAIN;
304 static int perf_spad_cmd_recv(struct perf_ctx *perf, int *pidx,
305 enum perf_cmd *cmd, u64 *data)
307 struct perf_peer *peer;
310 ntb_db_clear(perf->ntb, PERF_SPAD_NOTIFY(perf->gidx));
313 * We start scanning all over, since cleared DB may have been set
314 * by any peer. Yes, it makes peer with smaller index being
315 * serviced with greater priority, but it's convenient for spad
316 * and message code unification and simplicity.
318 for (*pidx = 0; *pidx < perf->pcnt; (*pidx)++) {
319 peer = &perf->peers[*pidx];
321 if (!perf_link_is_up(peer))
324 val = ntb_spad_read(perf->ntb, PERF_SPAD_CMD(peer->gidx));
325 if (val == PERF_CMD_INVAL)
330 val = ntb_spad_read(perf->ntb, PERF_SPAD_LDATA(peer->gidx));
333 val = ntb_spad_read(perf->ntb, PERF_SPAD_HDATA(peer->gidx));
334 *data |= (u64)val << 32;
336 /* Next command can be retrieved from now */
337 ntb_spad_write(perf->ntb, PERF_SPAD_CMD(peer->gidx),
340 dev_dbg(&perf->ntb->dev, "CMD recv: %d 0x%llx\n", *cmd, *data);
348 static int perf_msg_cmd_send(struct perf_peer *peer, enum perf_cmd cmd,
351 struct perf_ctx *perf = peer->perf;
355 dev_dbg(&perf->ntb->dev, "CMD send: %d 0x%llx\n", cmd, data);
358 * Perform predefined number of attempts before give up. Message
359 * registers are free of race-condition problem when accessed
360 * from different ports, so we don't need splitting registers
361 * by global device index. We also won't have local locking,
362 * since the method is used from service work only.
364 outbits = ntb_msg_outbits(perf->ntb);
365 for (try = 0; try < MSG_TRIES; try++) {
366 if (!perf_link_is_up(peer))
369 ret = ntb_msg_clear_sts(perf->ntb, outbits);
373 ntb_peer_msg_write(perf->ntb, peer->pidx, PERF_MSG_LDATA,
374 lower_32_bits(data));
376 if (ntb_msg_read_sts(perf->ntb) & outbits) {
377 usleep_range(MSG_UDELAY_LOW, MSG_UDELAY_HIGH);
381 ntb_peer_msg_write(perf->ntb, peer->pidx, PERF_MSG_HDATA,
382 upper_32_bits(data));
384 /* This call shall trigger peer message event */
385 ntb_peer_msg_write(perf->ntb, peer->pidx, PERF_MSG_CMD, cmd);
390 return try < MSG_TRIES ? 0 : -EAGAIN;
393 static int perf_msg_cmd_recv(struct perf_ctx *perf, int *pidx,
394 enum perf_cmd *cmd, u64 *data)
399 inbits = ntb_msg_inbits(perf->ntb);
401 if (hweight64(ntb_msg_read_sts(perf->ntb) & inbits) < 3)
404 val = ntb_msg_read(perf->ntb, pidx, PERF_MSG_CMD);
407 val = ntb_msg_read(perf->ntb, pidx, PERF_MSG_LDATA);
410 val = ntb_msg_read(perf->ntb, pidx, PERF_MSG_HDATA);
411 *data |= (u64)val << 32;
413 /* Next command can be retrieved from now */
414 ntb_msg_clear_sts(perf->ntb, inbits);
416 dev_dbg(&perf->ntb->dev, "CMD recv: %d 0x%llx\n", *cmd, *data);
421 static int perf_cmd_send(struct perf_peer *peer, enum perf_cmd cmd, u64 data)
423 struct perf_ctx *perf = peer->perf;
425 if (cmd == PERF_CMD_SSIZE || cmd == PERF_CMD_SXLAT)
426 return perf->cmd_send(peer, cmd, data);
428 dev_err(&perf->ntb->dev, "Send invalid command\n");
432 static int perf_cmd_exec(struct perf_peer *peer, enum perf_cmd cmd)
442 dev_err(&peer->perf->ntb->dev, "Exec invalid command\n");
446 /* No need of memory barrier, since bit ops have invernal lock */
447 set_bit(cmd, &peer->sts);
449 dev_dbg(&peer->perf->ntb->dev, "CMD exec: %d\n", cmd);
451 (void)queue_work(system_highpri_wq, &peer->service);
456 static int perf_cmd_recv(struct perf_ctx *perf)
458 struct perf_peer *peer;
462 while (!(ret = perf->cmd_recv(perf, &pidx, &cmd, &data))) {
463 peer = &perf->peers[pidx];
467 peer->inbuf_size = data;
468 return perf_cmd_exec(peer, PERF_CMD_RSIZE);
470 peer->outbuf_xlat = data;
471 return perf_cmd_exec(peer, PERF_CMD_RXLAT);
473 dev_err(&perf->ntb->dev, "Recv invalid command\n");
478 /* Return 0 if no data left to process, otherwise an error */
479 return ret == -ENODATA ? 0 : ret;
482 static void perf_link_event(void *ctx)
484 struct perf_ctx *perf = ctx;
485 struct perf_peer *peer;
489 for (pidx = 0; pidx < perf->pcnt; pidx++) {
490 peer = &perf->peers[pidx];
492 lnk_up = perf_link_is_up(peer);
495 !test_and_set_bit(PERF_STS_LNKUP, &peer->sts)) {
496 perf_cmd_exec(peer, PERF_CMD_SSIZE);
497 } else if (!lnk_up &&
498 test_and_clear_bit(PERF_STS_LNKUP, &peer->sts)) {
499 perf_cmd_exec(peer, PERF_CMD_CLEAR);
504 static void perf_db_event(void *ctx, int vec)
506 struct perf_ctx *perf = ctx;
508 dev_dbg(&perf->ntb->dev, "DB vec %d mask %#llx bits %#llx\n", vec,
509 ntb_db_vector_mask(perf->ntb, vec), ntb_db_read(perf->ntb));
511 /* Just receive all available commands */
512 (void)perf_cmd_recv(perf);
515 static void perf_msg_event(void *ctx)
517 struct perf_ctx *perf = ctx;
519 dev_dbg(&perf->ntb->dev, "Msg status bits %#llx\n",
520 ntb_msg_read_sts(perf->ntb));
522 /* Messages are only sent one-by-one */
523 (void)perf_cmd_recv(perf);
526 static const struct ntb_ctx_ops perf_ops = {
527 .link_event = perf_link_event,
528 .db_event = perf_db_event,
529 .msg_event = perf_msg_event
532 static void perf_free_outbuf(struct perf_peer *peer)
534 (void)ntb_peer_mw_clear_trans(peer->perf->ntb, peer->pidx, peer->gidx);
537 static int perf_setup_outbuf(struct perf_peer *peer)
539 struct perf_ctx *perf = peer->perf;
542 /* Outbuf size can be unaligned due to custom max_mw_size */
543 ret = ntb_peer_mw_set_trans(perf->ntb, peer->pidx, peer->gidx,
544 peer->outbuf_xlat, peer->outbuf_size);
546 dev_err(&perf->ntb->dev, "Failed to set outbuf translation\n");
550 /* Initialization is finally done */
551 set_bit(PERF_STS_DONE, &peer->sts);
552 complete_all(&peer->init_comp);
557 static void perf_free_inbuf(struct perf_peer *peer)
562 (void)ntb_mw_clear_trans(peer->perf->ntb, peer->pidx, peer->gidx);
563 dma_free_coherent(&peer->perf->ntb->pdev->dev, peer->inbuf_size,
564 peer->inbuf, peer->inbuf_xlat);
568 static int perf_setup_inbuf(struct perf_peer *peer)
570 resource_size_t xlat_align, size_align, size_max;
571 struct perf_ctx *perf = peer->perf;
574 /* Get inbound MW parameters */
575 ret = ntb_mw_get_align(perf->ntb, peer->pidx, perf->gidx,
576 &xlat_align, &size_align, &size_max);
578 dev_err(&perf->ntb->dev, "Couldn't get inbuf restrictions\n");
582 if (peer->inbuf_size > size_max) {
583 dev_err(&perf->ntb->dev, "Too big inbuf size %pa > %pa\n",
584 &peer->inbuf_size, &size_max);
588 peer->inbuf_size = round_up(peer->inbuf_size, size_align);
590 perf_free_inbuf(peer);
592 peer->inbuf = dma_alloc_coherent(&perf->ntb->pdev->dev,
593 peer->inbuf_size, &peer->inbuf_xlat,
596 dev_err(&perf->ntb->dev, "Failed to alloc inbuf of %pa\n",
600 if (!IS_ALIGNED(peer->inbuf_xlat, xlat_align)) {
602 dev_err(&perf->ntb->dev, "Unaligned inbuf allocated\n");
606 ret = ntb_mw_set_trans(perf->ntb, peer->pidx, peer->gidx,
607 peer->inbuf_xlat, peer->inbuf_size);
609 dev_err(&perf->ntb->dev, "Failed to set inbuf translation\n");
614 * We submit inbuf xlat transmission cmd for execution here to follow
615 * the code architecture, even though this method is called from service
616 * work itself so the command will be executed right after it returns.
618 (void)perf_cmd_exec(peer, PERF_CMD_SXLAT);
623 perf_free_inbuf(peer);
628 static void perf_service_work(struct work_struct *work)
630 struct perf_peer *peer = to_peer_service(work);
632 if (test_and_clear_bit(PERF_CMD_SSIZE, &peer->sts))
633 perf_cmd_send(peer, PERF_CMD_SSIZE, peer->outbuf_size);
635 if (test_and_clear_bit(PERF_CMD_RSIZE, &peer->sts))
636 perf_setup_inbuf(peer);
638 if (test_and_clear_bit(PERF_CMD_SXLAT, &peer->sts))
639 perf_cmd_send(peer, PERF_CMD_SXLAT, peer->inbuf_xlat);
641 if (test_and_clear_bit(PERF_CMD_RXLAT, &peer->sts))
642 perf_setup_outbuf(peer);
644 if (test_and_clear_bit(PERF_CMD_CLEAR, &peer->sts)) {
645 init_completion(&peer->init_comp);
646 clear_bit(PERF_STS_DONE, &peer->sts);
647 if (test_bit(0, &peer->perf->busy_flag) &&
648 peer == peer->perf->test_peer) {
649 dev_warn(&peer->perf->ntb->dev,
650 "Freeing while test on-fly\n");
651 perf_terminate_test(peer->perf);
653 perf_free_outbuf(peer);
654 perf_free_inbuf(peer);
658 static int perf_init_service(struct perf_ctx *perf)
662 if (ntb_peer_mw_count(perf->ntb) < perf->pcnt) {
663 dev_err(&perf->ntb->dev, "Not enough memory windows\n");
667 if (ntb_msg_count(perf->ntb) >= PERF_MSG_CNT) {
668 perf->cmd_send = perf_msg_cmd_send;
669 perf->cmd_recv = perf_msg_cmd_recv;
671 dev_dbg(&perf->ntb->dev, "Message service initialized\n");
676 dev_dbg(&perf->ntb->dev, "Message service unsupported\n");
678 mask = GENMASK_ULL(perf->pcnt, 0);
679 if (ntb_spad_count(perf->ntb) >= PERF_SPAD_CNT(perf->pcnt) &&
680 (ntb_db_valid_mask(perf->ntb) & mask) == mask) {
681 perf->cmd_send = perf_spad_cmd_send;
682 perf->cmd_recv = perf_spad_cmd_recv;
684 dev_dbg(&perf->ntb->dev, "Scratchpad service initialized\n");
689 dev_dbg(&perf->ntb->dev, "Scratchpad service unsupported\n");
691 dev_err(&perf->ntb->dev, "Command services unsupported\n");
696 static int perf_enable_service(struct perf_ctx *perf)
701 mask = ntb_db_valid_mask(perf->ntb);
702 (void)ntb_db_set_mask(perf->ntb, mask);
704 ret = ntb_set_ctx(perf->ntb, perf, &perf_ops);
708 if (perf->cmd_send == perf_msg_cmd_send) {
711 inbits = ntb_msg_inbits(perf->ntb);
712 outbits = ntb_msg_outbits(perf->ntb);
713 (void)ntb_msg_set_mask(perf->ntb, inbits | outbits);
715 incmd_bit = BIT_ULL(__ffs64(inbits));
716 ret = ntb_msg_clear_mask(perf->ntb, incmd_bit);
718 dev_dbg(&perf->ntb->dev, "MSG sts unmasked %#llx\n", incmd_bit);
720 scnt = ntb_spad_count(perf->ntb);
721 for (sidx = 0; sidx < scnt; sidx++)
722 ntb_spad_write(perf->ntb, sidx, PERF_CMD_INVAL);
723 incmd_bit = PERF_SPAD_NOTIFY(perf->gidx);
724 ret = ntb_db_clear_mask(perf->ntb, incmd_bit);
726 dev_dbg(&perf->ntb->dev, "DB bits unmasked %#llx\n", incmd_bit);
729 ntb_clear_ctx(perf->ntb);
733 ntb_link_enable(perf->ntb, NTB_SPEED_AUTO, NTB_WIDTH_AUTO);
734 /* Might be not necessary */
735 ntb_link_event(perf->ntb);
740 static void perf_disable_service(struct perf_ctx *perf)
744 if (perf->cmd_send == perf_msg_cmd_send) {
747 inbits = ntb_msg_inbits(perf->ntb);
748 (void)ntb_msg_set_mask(perf->ntb, inbits);
750 (void)ntb_db_set_mask(perf->ntb, PERF_SPAD_NOTIFY(perf->gidx));
753 ntb_clear_ctx(perf->ntb);
755 for (pidx = 0; pidx < perf->pcnt; pidx++)
756 perf_cmd_exec(&perf->peers[pidx], PERF_CMD_CLEAR);
758 for (pidx = 0; pidx < perf->pcnt; pidx++)
759 flush_work(&perf->peers[pidx].service);
761 for (pidx = 0; pidx < perf->pcnt; pidx++) {
762 struct perf_peer *peer = &perf->peers[pidx];
764 ntb_spad_write(perf->ntb, PERF_SPAD_CMD(peer->gidx), 0);
767 ntb_db_clear(perf->ntb, PERF_SPAD_NOTIFY(perf->gidx));
769 ntb_link_disable(perf->ntb);
772 /*==============================================================================
773 * Performance measuring work-thread
774 *==============================================================================
777 static void perf_dma_copy_callback(void *data)
779 struct perf_thread *pthr = data;
781 atomic_dec(&pthr->dma_sync);
782 wake_up(&pthr->dma_wait);
785 static int perf_copy_chunk(struct perf_thread *pthr,
786 void __iomem *dst, void *src, size_t len)
788 struct dma_async_tx_descriptor *tx;
789 struct dmaengine_unmap_data *unmap;
790 struct device *dma_dev;
791 int try = 0, ret = 0;
792 struct perf_peer *peer = pthr->perf->test_peer;
794 void __iomem *dst_vaddr;
795 dma_addr_t dst_dma_addr;
798 memcpy_toio(dst, src, len);
799 goto ret_check_tsync;
802 dma_dev = pthr->dma_chan->device->dev;
804 if (!is_dma_copy_aligned(pthr->dma_chan->device, offset_in_page(src),
805 offset_in_page(dst), len))
808 vbase = peer->outbuf;
810 dst_dma_addr = peer->dma_dst_addr + (dst_vaddr - vbase);
812 unmap = dmaengine_get_unmap_data(dma_dev, 1, GFP_NOWAIT);
817 unmap->addr[0] = dma_map_page(dma_dev, virt_to_page(src),
818 offset_in_page(src), len, DMA_TO_DEVICE);
819 if (dma_mapping_error(dma_dev, unmap->addr[0])) {
821 goto err_free_resource;
826 tx = dmaengine_prep_dma_memcpy(pthr->dma_chan, dst_dma_addr,
827 unmap->addr[0], len, DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
830 } while (!tx && (try++ < DMA_TRIES));
834 goto err_free_resource;
837 tx->callback = perf_dma_copy_callback;
838 tx->callback_param = pthr;
839 dma_set_unmap(tx, unmap);
841 ret = dma_submit_error(dmaengine_submit(tx));
843 dmaengine_unmap_put(unmap);
844 goto err_free_resource;
847 dmaengine_unmap_put(unmap);
849 atomic_inc(&pthr->dma_sync);
850 dma_async_issue_pending(pthr->dma_chan);
853 return likely(atomic_read(&pthr->perf->tsync) > 0) ? 0 : -EINTR;
856 dmaengine_unmap_put(unmap);
861 static bool perf_dma_filter(struct dma_chan *chan, void *data)
863 struct perf_ctx *perf = data;
866 node = dev_to_node(&perf->ntb->dev);
868 return node == NUMA_NO_NODE || node == dev_to_node(chan->device->dev);
871 static int perf_init_test(struct perf_thread *pthr)
873 struct perf_ctx *perf = pthr->perf;
874 dma_cap_mask_t dma_mask;
875 struct perf_peer *peer = pthr->perf->test_peer;
877 pthr->src = kmalloc_node(perf->test_peer->outbuf_size, GFP_KERNEL,
878 dev_to_node(&perf->ntb->dev));
882 get_random_bytes(pthr->src, perf->test_peer->outbuf_size);
887 dma_cap_zero(dma_mask);
888 dma_cap_set(DMA_MEMCPY, dma_mask);
889 pthr->dma_chan = dma_request_channel(dma_mask, perf_dma_filter, perf);
890 if (!pthr->dma_chan) {
891 dev_err(&perf->ntb->dev, "%d: Failed to get DMA channel\n",
896 dma_map_resource(pthr->dma_chan->device->dev,
897 peer->out_phys_addr, peer->outbuf_size,
899 if (dma_mapping_error(pthr->dma_chan->device->dev,
900 peer->dma_dst_addr)) {
901 dev_err(pthr->dma_chan->device->dev, "%d: Failed to map DMA addr\n",
903 peer->dma_dst_addr = 0;
904 dma_release_channel(pthr->dma_chan);
907 dev_dbg(pthr->dma_chan->device->dev, "%d: Map MMIO %pa to DMA addr %pad\n",
909 &peer->out_phys_addr,
910 &peer->dma_dst_addr);
912 atomic_set(&pthr->dma_sync, 0);
916 atomic_dec(&perf->tsync);
917 wake_up(&perf->twait);
922 static int perf_run_test(struct perf_thread *pthr)
924 struct perf_peer *peer = pthr->perf->test_peer;
925 struct perf_ctx *perf = pthr->perf;
926 void __iomem *flt_dst, *bnd_dst;
927 u64 total_size, chunk_size;
931 total_size = 1ULL << total_order;
932 chunk_size = 1ULL << chunk_order;
933 chunk_size = min_t(u64, peer->outbuf_size, chunk_size);
936 bnd_dst = peer->outbuf + peer->outbuf_size;
937 flt_dst = peer->outbuf;
939 pthr->duration = ktime_get();
941 /* Copied field is cleared on test launch stage */
942 while (pthr->copied < total_size) {
943 ret = perf_copy_chunk(pthr, flt_dst, flt_src, chunk_size);
945 dev_err(&perf->ntb->dev, "%d: Got error %d on test\n",
950 pthr->copied += chunk_size;
952 flt_dst += chunk_size;
953 flt_src += chunk_size;
954 if (flt_dst >= bnd_dst || flt_dst < peer->outbuf) {
955 flt_dst = peer->outbuf;
959 /* Give up CPU to give a chance for other threads to use it */
966 static int perf_sync_test(struct perf_thread *pthr)
968 struct perf_ctx *perf = pthr->perf;
973 wait_event(pthr->dma_wait,
974 (atomic_read(&pthr->dma_sync) == 0 ||
975 atomic_read(&perf->tsync) < 0));
977 if (atomic_read(&perf->tsync) < 0)
981 pthr->duration = ktime_sub(ktime_get(), pthr->duration);
983 dev_dbg(&perf->ntb->dev, "%d: copied %llu bytes\n",
984 pthr->tidx, pthr->copied);
986 dev_dbg(&perf->ntb->dev, "%d: lasted %llu usecs\n",
987 pthr->tidx, ktime_to_us(pthr->duration));
989 dev_dbg(&perf->ntb->dev, "%d: %llu MBytes/s\n", pthr->tidx,
990 div64_u64(pthr->copied, ktime_to_us(pthr->duration)));
995 static void perf_clear_test(struct perf_thread *pthr)
997 struct perf_ctx *perf = pthr->perf;
1003 * If test finished without errors, termination isn't needed.
1004 * We call it anyway just to be sure of the transfers completion.
1006 (void)dmaengine_terminate_sync(pthr->dma_chan);
1007 if (pthr->perf->test_peer->dma_dst_addr)
1008 dma_unmap_resource(pthr->dma_chan->device->dev,
1009 pthr->perf->test_peer->dma_dst_addr,
1010 pthr->perf->test_peer->outbuf_size,
1011 DMA_FROM_DEVICE, 0);
1013 dma_release_channel(pthr->dma_chan);
1016 atomic_dec(&perf->tsync);
1017 wake_up(&perf->twait);
1021 static void perf_thread_work(struct work_struct *work)
1023 struct perf_thread *pthr = to_thread_work(work);
1027 * Perform stages in compliance with use_dma flag value.
1028 * Test status is changed only if error happened, otherwise
1029 * status -ENODATA is kept while test is on-fly. Results
1030 * synchronization is performed only if test fininshed
1031 * without an error or interruption.
1033 ret = perf_init_test(pthr);
1039 ret = perf_run_test(pthr);
1042 goto err_clear_test;
1045 pthr->status = perf_sync_test(pthr);
1048 perf_clear_test(pthr);
1051 static int perf_set_tcnt(struct perf_ctx *perf, u8 tcnt)
1053 if (tcnt == 0 || tcnt > MAX_THREADS_CNT)
1056 if (test_and_set_bit_lock(0, &perf->busy_flag))
1061 clear_bit_unlock(0, &perf->busy_flag);
1066 static void perf_terminate_test(struct perf_ctx *perf)
1070 atomic_set(&perf->tsync, -1);
1071 wake_up(&perf->twait);
1073 for (tidx = 0; tidx < MAX_THREADS_CNT; tidx++) {
1074 wake_up(&perf->threads[tidx].dma_wait);
1075 cancel_work_sync(&perf->threads[tidx].work);
1079 static int perf_submit_test(struct perf_peer *peer)
1081 struct perf_ctx *perf = peer->perf;
1082 struct perf_thread *pthr;
1085 ret = wait_for_completion_interruptible(&peer->init_comp);
1089 if (test_and_set_bit_lock(0, &perf->busy_flag))
1092 perf->test_peer = peer;
1093 atomic_set(&perf->tsync, perf->tcnt);
1095 for (tidx = 0; tidx < MAX_THREADS_CNT; tidx++) {
1096 pthr = &perf->threads[tidx];
1098 pthr->status = -ENODATA;
1100 pthr->duration = ktime_set(0, 0);
1101 if (tidx < perf->tcnt)
1102 (void)queue_work(perf_wq, &pthr->work);
1105 ret = wait_event_interruptible(perf->twait,
1106 atomic_read(&perf->tsync) <= 0);
1107 if (ret == -ERESTARTSYS) {
1108 perf_terminate_test(perf);
1112 clear_bit_unlock(0, &perf->busy_flag);
1117 static int perf_read_stats(struct perf_ctx *perf, char *buf,
1118 size_t size, ssize_t *pos)
1120 struct perf_thread *pthr;
1123 if (test_and_set_bit_lock(0, &perf->busy_flag))
1126 (*pos) += scnprintf(buf + *pos, size - *pos,
1127 " Peer %d test statistics:\n", perf->test_peer->pidx);
1129 for (tidx = 0; tidx < MAX_THREADS_CNT; tidx++) {
1130 pthr = &perf->threads[tidx];
1132 if (pthr->status == -ENODATA)
1136 (*pos) += scnprintf(buf + *pos, size - *pos,
1137 "%d: error status %d\n", tidx, pthr->status);
1141 (*pos) += scnprintf(buf + *pos, size - *pos,
1142 "%d: copied %llu bytes in %llu usecs, %llu MBytes/s\n",
1143 tidx, pthr->copied, ktime_to_us(pthr->duration),
1144 div64_u64(pthr->copied, ktime_to_us(pthr->duration)));
1147 clear_bit_unlock(0, &perf->busy_flag);
1152 static void perf_init_threads(struct perf_ctx *perf)
1154 struct perf_thread *pthr;
1157 perf->tcnt = DEF_THREADS_CNT;
1158 perf->test_peer = &perf->peers[0];
1159 init_waitqueue_head(&perf->twait);
1161 for (tidx = 0; tidx < MAX_THREADS_CNT; tidx++) {
1162 pthr = &perf->threads[tidx];
1166 pthr->status = -ENODATA;
1167 init_waitqueue_head(&pthr->dma_wait);
1168 INIT_WORK(&pthr->work, perf_thread_work);
1172 static void perf_clear_threads(struct perf_ctx *perf)
1174 perf_terminate_test(perf);
1177 /*==============================================================================
1179 *==============================================================================
1182 static ssize_t perf_dbgfs_read_info(struct file *filep, char __user *ubuf,
1183 size_t size, loff_t *offp)
1185 struct perf_ctx *perf = filep->private_data;
1186 struct perf_peer *peer;
1192 buf_size = min_t(size_t, size, 0x1000U);
1194 buf = kmalloc(buf_size, GFP_KERNEL);
1198 pos += scnprintf(buf + pos, buf_size - pos,
1199 " Performance measuring tool info:\n\n");
1201 pos += scnprintf(buf + pos, buf_size - pos,
1202 "Local port %d, Global index %d\n", ntb_port_number(perf->ntb),
1204 pos += scnprintf(buf + pos, buf_size - pos, "Test status: ");
1205 if (test_bit(0, &perf->busy_flag)) {
1206 pos += scnprintf(buf + pos, buf_size - pos,
1207 "on-fly with port %d (%d)\n",
1208 ntb_peer_port_number(perf->ntb, perf->test_peer->pidx),
1209 perf->test_peer->pidx);
1211 pos += scnprintf(buf + pos, buf_size - pos, "idle\n");
1214 for (pidx = 0; pidx < perf->pcnt; pidx++) {
1215 peer = &perf->peers[pidx];
1217 pos += scnprintf(buf + pos, buf_size - pos,
1218 "Port %d (%d), Global index %d:\n",
1219 ntb_peer_port_number(perf->ntb, peer->pidx), peer->pidx,
1222 pos += scnprintf(buf + pos, buf_size - pos,
1223 "\tLink status: %s\n",
1224 test_bit(PERF_STS_LNKUP, &peer->sts) ? "up" : "down");
1226 pos += scnprintf(buf + pos, buf_size - pos,
1227 "\tOut buffer addr 0x%pK\n", peer->outbuf);
1229 pos += scnprintf(buf + pos, buf_size - pos,
1230 "\tOut buff phys addr %pa[p]\n", &peer->out_phys_addr);
1232 pos += scnprintf(buf + pos, buf_size - pos,
1233 "\tOut buffer size %pa\n", &peer->outbuf_size);
1235 pos += scnprintf(buf + pos, buf_size - pos,
1236 "\tOut buffer xlat 0x%016llx[p]\n", peer->outbuf_xlat);
1239 pos += scnprintf(buf + pos, buf_size - pos,
1240 "\tIn buffer addr: unallocated\n");
1244 pos += scnprintf(buf + pos, buf_size - pos,
1245 "\tIn buffer addr 0x%pK\n", peer->inbuf);
1247 pos += scnprintf(buf + pos, buf_size - pos,
1248 "\tIn buffer size %pa\n", &peer->inbuf_size);
1250 pos += scnprintf(buf + pos, buf_size - pos,
1251 "\tIn buffer xlat %pad[p]\n", &peer->inbuf_xlat);
1254 ret = simple_read_from_buffer(ubuf, size, offp, buf, pos);
1260 static const struct file_operations perf_dbgfs_info = {
1261 .open = simple_open,
1262 .read = perf_dbgfs_read_info
1265 static ssize_t perf_dbgfs_read_run(struct file *filep, char __user *ubuf,
1266 size_t size, loff_t *offp)
1268 struct perf_ctx *perf = filep->private_data;
1269 ssize_t ret, pos = 0;
1272 buf = kmalloc(PERF_BUF_LEN, GFP_KERNEL);
1276 ret = perf_read_stats(perf, buf, PERF_BUF_LEN, &pos);
1280 ret = simple_read_from_buffer(ubuf, size, offp, buf, pos);
1287 static ssize_t perf_dbgfs_write_run(struct file *filep, const char __user *ubuf,
1288 size_t size, loff_t *offp)
1290 struct perf_ctx *perf = filep->private_data;
1291 struct perf_peer *peer;
1294 ret = kstrtoint_from_user(ubuf, size, 0, &pidx);
1298 if (pidx < 0 || pidx >= perf->pcnt)
1301 peer = &perf->peers[pidx];
1303 ret = perf_submit_test(peer);
1310 static const struct file_operations perf_dbgfs_run = {
1311 .open = simple_open,
1312 .read = perf_dbgfs_read_run,
1313 .write = perf_dbgfs_write_run
1316 static ssize_t perf_dbgfs_read_tcnt(struct file *filep, char __user *ubuf,
1317 size_t size, loff_t *offp)
1319 struct perf_ctx *perf = filep->private_data;
1323 pos = scnprintf(buf, sizeof(buf), "%hhu\n", perf->tcnt);
1325 return simple_read_from_buffer(ubuf, size, offp, buf, pos);
1328 static ssize_t perf_dbgfs_write_tcnt(struct file *filep,
1329 const char __user *ubuf,
1330 size_t size, loff_t *offp)
1332 struct perf_ctx *perf = filep->private_data;
1336 ret = kstrtou8_from_user(ubuf, size, 0, &val);
1340 ret = perf_set_tcnt(perf, val);
1347 static const struct file_operations perf_dbgfs_tcnt = {
1348 .open = simple_open,
1349 .read = perf_dbgfs_read_tcnt,
1350 .write = perf_dbgfs_write_tcnt
1353 static void perf_setup_dbgfs(struct perf_ctx *perf)
1355 struct pci_dev *pdev = perf->ntb->pdev;
1357 perf->dbgfs_dir = debugfs_create_dir(pci_name(pdev), perf_dbgfs_topdir);
1358 if (!perf->dbgfs_dir) {
1359 dev_warn(&perf->ntb->dev, "DebugFS unsupported\n");
1363 debugfs_create_file("info", 0600, perf->dbgfs_dir, perf,
1366 debugfs_create_file("run", 0600, perf->dbgfs_dir, perf,
1369 debugfs_create_file("threads_count", 0600, perf->dbgfs_dir, perf,
1372 /* They are made read-only for test exec safety and integrity */
1373 debugfs_create_u8("chunk_order", 0500, perf->dbgfs_dir, &chunk_order);
1375 debugfs_create_u8("total_order", 0500, perf->dbgfs_dir, &total_order);
1377 debugfs_create_bool("use_dma", 0500, perf->dbgfs_dir, &use_dma);
1380 static void perf_clear_dbgfs(struct perf_ctx *perf)
1382 debugfs_remove_recursive(perf->dbgfs_dir);
1385 /*==============================================================================
1386 * Basic driver initialization
1387 *==============================================================================
1390 static struct perf_ctx *perf_create_data(struct ntb_dev *ntb)
1392 struct perf_ctx *perf;
1394 perf = devm_kzalloc(&ntb->dev, sizeof(*perf), GFP_KERNEL);
1396 return ERR_PTR(-ENOMEM);
1398 perf->pcnt = ntb_peer_port_count(ntb);
1399 perf->peers = devm_kcalloc(&ntb->dev, perf->pcnt, sizeof(*perf->peers),
1402 return ERR_PTR(-ENOMEM);
1409 static int perf_setup_peer_mw(struct perf_peer *peer)
1411 struct perf_ctx *perf = peer->perf;
1412 phys_addr_t phys_addr;
1415 /* Get outbound MW parameters and map it */
1416 ret = ntb_peer_mw_get_addr(perf->ntb, perf->gidx, &phys_addr,
1417 &peer->outbuf_size);
1421 peer->outbuf = devm_ioremap_wc(&perf->ntb->dev, phys_addr,
1426 peer->out_phys_addr = phys_addr;
1428 if (max_mw_size && peer->outbuf_size > max_mw_size) {
1429 peer->outbuf_size = max_mw_size;
1430 dev_warn(&peer->perf->ntb->dev,
1431 "Peer %d outbuf reduced to %pa\n", peer->pidx,
1432 &peer->outbuf_size);
1438 static int perf_init_peers(struct perf_ctx *perf)
1440 struct perf_peer *peer;
1441 int pidx, lport, ret;
1443 lport = ntb_port_number(perf->ntb);
1445 for (pidx = 0; pidx < perf->pcnt; pidx++) {
1446 peer = &perf->peers[pidx];
1450 if (lport < ntb_peer_port_number(perf->ntb, pidx)) {
1451 if (perf->gidx == -1)
1453 peer->gidx = pidx + 1;
1457 INIT_WORK(&peer->service, perf_service_work);
1458 init_completion(&peer->init_comp);
1460 if (perf->gidx == -1)
1464 * Hardware with only two ports may not have unique port
1465 * numbers. In this case, the gidxs should all be zero.
1467 if (perf->pcnt == 1 && ntb_port_number(perf->ntb) == 0 &&
1468 ntb_peer_port_number(perf->ntb, 0) == 0) {
1470 perf->peers[0].gidx = 0;
1473 for (pidx = 0; pidx < perf->pcnt; pidx++) {
1474 ret = perf_setup_peer_mw(&perf->peers[pidx]);
1479 dev_dbg(&perf->ntb->dev, "Global port index %d\n", perf->gidx);
1484 static int perf_probe(struct ntb_client *client, struct ntb_dev *ntb)
1486 struct perf_ctx *perf;
1489 perf = perf_create_data(ntb);
1491 return PTR_ERR(perf);
1493 ret = perf_init_peers(perf);
1497 perf_init_threads(perf);
1499 ret = perf_init_service(perf);
1503 ret = perf_enable_service(perf);
1507 perf_setup_dbgfs(perf);
1512 static void perf_remove(struct ntb_client *client, struct ntb_dev *ntb)
1514 struct perf_ctx *perf = ntb->ctx;
1516 perf_clear_dbgfs(perf);
1518 perf_disable_service(perf);
1520 perf_clear_threads(perf);
1523 static struct ntb_client perf_client = {
1525 .probe = perf_probe,
1526 .remove = perf_remove
1530 static int __init perf_init(void)
1534 if (chunk_order > MAX_CHUNK_ORDER) {
1535 chunk_order = MAX_CHUNK_ORDER;
1536 pr_info("Chunk order reduced to %hhu\n", chunk_order);
1539 if (total_order < chunk_order) {
1540 total_order = chunk_order;
1541 pr_info("Total data order reduced to %hhu\n", total_order);
1544 perf_wq = alloc_workqueue("perf_wq", WQ_UNBOUND | WQ_SYSFS, 0);
1548 if (debugfs_initialized())
1549 perf_dbgfs_topdir = debugfs_create_dir(KBUILD_MODNAME, NULL);
1551 ret = ntb_register_client(&perf_client);
1553 debugfs_remove_recursive(perf_dbgfs_topdir);
1554 destroy_workqueue(perf_wq);
1559 module_init(perf_init);
1561 static void __exit perf_exit(void)
1563 ntb_unregister_client(&perf_client);
1564 debugfs_remove_recursive(perf_dbgfs_topdir);
1565 destroy_workqueue(perf_wq);
1567 module_exit(perf_exit);