From patchwork Tue May 24 20:06:43 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jarod Wilson X-Patchwork-Id: 9134233 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 8CC546075E for ; Tue, 24 May 2016 20:06:52 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 6827224B5B for ; Tue, 24 May 2016 20:06:52 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 5A89628233; Tue, 24 May 2016 20:06:52 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=2.0 tests=BAYES_00,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id B69A124B5B for ; Tue, 24 May 2016 20:06:51 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932564AbcEXUGu (ORCPT ); Tue, 24 May 2016 16:06:50 -0400 Received: from mx1.redhat.com ([209.132.183.28]:44665 "EHLO mx1.redhat.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1754681AbcEXUGt (ORCPT ); Tue, 24 May 2016 16:06:49 -0400 Received: from int-mx10.intmail.prod.int.phx2.redhat.com (int-mx10.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id B74CC6265D; Tue, 24 May 2016 20:06:48 +0000 (UTC) Received: from hp-dl360pgen8-07.khw.lab.eng.bos.redhat.com (hp-dl360pgen8-07.khw.lab.eng.bos.redhat.com [10.16.184.47]) by int-mx10.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id u4OK6l3T032694; Tue, 24 May 2016 16:06:48 -0400 From: Jarod Wilson To: linux-rdma@vger.kernel.org Cc: Jarod Wilson , Roland Dreier Subject: [PATCH libibverbs] Add basic man page entry for ibv_xsrq_pingpong Date: Tue, 24 May 2016 16:06:43 -0400 Message-Id: <1464120403-39680-1-git-send-email-jarod@redhat.com> X-Scanned-By: MIMEDefang 2.68 on 10.5.11.23 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.39]); Tue, 24 May 2016 20:06:48 +0000 (UTC) Sender: linux-rdma-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-rdma@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP We have internal tools that complain about any binaries that are missing corresponding man pages, and all the other examples have 'em. Shamelessly ripped off from ibv_srq_pingpong's man page. CC: Roland Dreier Signed-off-by: Jarod Wilson --- man/ibv_xsrq_pingpong.1 | 71 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 man/ibv_xsrq_pingpong.1 diff --git a/man/ibv_xsrq_pingpong.1 b/man/ibv_xsrq_pingpong.1 new file mode 100644 index 0000000..db4a988 --- /dev/null +++ b/man/ibv_xsrq_pingpong.1 @@ -0,0 +1,71 @@ +.TH IBV_XSRQ_PINGPONG 1 "May 24, 2016" "libibverbs" "USER COMMANDS" + +.SH NAME +ibv_xsrq_pingpong \- simple InfiniBand shared receive queue test + +.SH SYNOPSIS +.B ibv_xsrq_pingpong +[\-p port] [\-d device] [\-i ib port] [\-s size] [\-m mtu] [\-c clients] +[\-n num_tests] [\-l sl] [\-e] \fBHOSTNAME\fR + +.B ibv_xsrq_pingpong +[\-p port] [\-d device] [\-i ib port] [\-s size] [\-m mtu] [\-c clients] +[\-n num_tests] [\-l sl] [\-e] + +.SH DESCRIPTION +.PP +Run a simple ping-pong test over InfiniBand via the extended reliable +connected (XRC) transport service, using a shared receive queue (SRQ). + +.SH OPTIONS + +.PP +.TP +\fB\-p\fR, \fB\-\-port\fR=\fIPORT\fR +use TCP port \fIPORT\fR for initial synchronization (default 18515) +.TP +\fB\-d\fR, \fB\-\-ib\-dev\fR=\fIDEVICE\fR +use IB device \fIDEVICE\fR (default first device found) +.TP +\fB\-i\fR, \fB\-\-ib\-port\fR=\fIPORT\fR +use IB port \fIPORT\fR (default port 1) +.TP +\fB\-s\fR, \fB\-\-size\fR=\fISIZE\fR +ping-pong messages of size \fISIZE\fR (default 4096) +.TP +\fB\-m\fR, \fB\-\-mtu\fR=\fIMTU\fR +use path mtu of size \fIMTU\fR (default 2048) +.TP +\fB\-c\fR, \fB\-\-clients\fR=\fICLIENTS\fR +number of clients \fICLIENTS\fR (on server only, default 1) +.TP +\fB\-n\fR, \fB\-\-num\-tests\fR=\fINUM_TESTS\fR +perform \fINUM_TESTS\fR tests per client (default 5) +.TP +\fB\-l\fR, \fB\-\-sl\fR=\fISL\fR +use \fISL\fR as the service level value (default 0) +.TP +\fB\-e\fR, \fB\-\-events\fR +sleep while waiting for work completion events (default is to poll for +completions) + +.SH SEE ALSO +.BR ibv_rc_pingpong (1), +.BR ibv_uc_pingpong (1), +.BR ibv_ud_pingpong (1) +.BR ibv_srq_pingpong (1) + +.SH AUTHORS +.TP +Roland Dreier +.RI < roland@purestorage.com > +.TP +Jarod Wilson +.RI < jarod@redhat.com > + +.SH BUGS +The network synchronization between client and server instances is +weak, and does not prevent incompatible options from being used on the +two instances. The method used for retrieving work completions is not +strictly correct, and race conditions may cause failures on some +systems.