RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 1416541 - [RHEL-7.4] ibv_*_pingpong manpages missing many options from ibv_*_pingpong --help
Summary: [RHEL-7.4] ibv_*_pingpong manpages missing many options from ibv_*_pingpong -...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 7
Classification: Red Hat
Component: libibverbs
Version: 7.4
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: rc
: ---
Assignee: Jarod Wilson
QA Contact: Mike Stowell
URL:
Whiteboard:
Depends On:
Blocks: 1353018
TreeView+ depends on / blocked
 
Reported: 2017-01-25 18:43 UTC by Mike Stowell
Modified: 2017-08-01 16:57 UTC (History)
4 users (show)

Fixed In Version: rdma-core-12-3.el7
Doc Type: No Doc Update
Doc Text:
undefined
Clone Of:
Environment:
Last Closed: 2017-08-01 16:57:45 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHEA-2017:2011 0 normal SHIPPED_LIVE RDMA stack bug fix and enhancement update 2017-08-01 17:59:05 UTC

Description Mike Stowell 2017-01-25 18:43:21 UTC 
Description of problem:
We can run ibv_rc_pingpong with -t flag to get min/max/average completion clock cycles.  However, `man ibv_rc_pingpong` does not say anything about this option.

Version-Release number of selected component (if applicable):
libibverbs-utils-1.2.1-1.el7.x86_64

How reproducible:
always

Steps to Reproduce:
1. man ibv_rc_pingpong

Actual results:
No entry for "-t" flag

Expected results:
Entry for ibv_rc_pingpong w/ "-t"

Additional info:
~$ ibv_rc_pingpong -t 172.31.0.6
  local address:  LID 0x000e, QPN 0x000081, PSN 0x0441f3, GID ::
  remote address: LID 0x0022, QPN 0x000075, PSN 0xc1572a, GID ::
8192000 bytes in 0.00 seconds = 15337.23 Mbit/sec
1000 iters in 0.00 seconds = 4.27 usec/iter
Max receive completion clock cycles = 2502
Min receive completion clock cycles = 640
Average receive completion clock cycles = 666.791792
Comment 1 Mike Stowell 2017-01-25 18:57:59 UTC 
There's actually quite a few options missing from the manpage that do show in ibv_rc_pingpong --help.  These are:
  -m, --mtu=<size>       path MTU (default 1024)
  -g, --gid-idx=<gid index> local port gid index
  -o, --odp		    use on demand paging
  -t, --ts	            get CQE with timestamp

##

This also goes for the manpage of ibv_uc_pingpong missing:
  -m, --mtu=<size>       path MTU (default 1024)
  -g, --gid-idx=<gid index> local port gid index

##

The manpage of ibv_ud_pingpong is missing:
  -g, --gid-idx=<gid index> local port gid index

Also, ibv_ud_pingpong manpage has the -l flag:
       -l, --sl=SL
              send messages with service level SL (default 0)
but it is missing from `ibv_ud_pingpong --help`.

##

Plus the manpage ibv_srq_pingpong is missing:
  -m, --mtu=<size>       path MTU (default 1024)
  -g, --gid-idx=<gid index> local port gid index
Comment 2 Mike Stowell 2017-01-25 19:19:03 UTC 
Forgot one more: ibv_xsrq_pingpong is missing:
  -g, --gid-idx=<gid index> local port gid index
from its manpage.

The reason I had almost forgot about ibv_xsrq_pingpong is because it is not mentioned in the "SEE ALSO" of the other ibv_*_pingpong manpages, even though ibv_xsrq_pingpong points out to the other four.  I assume this should be updated in the other four [ibv_rc_pingpong(1), ibv_uc_pingpong(1), ibv_ud_pingpong(1) ibv_srq_pingpong(1)] manpages as well.
Comment 3 Mike Stowell 2017-01-25 20:03:49 UTC 
Upstream pull request: https://github.com/linux-rdma/rdma-core/pull/62
Comment 4 Jarod Wilson 2017-01-25 23:17:13 UTC 
(In reply to Mike Stowell from comment #3)
> Upstream pull request: https://github.com/linux-rdma/rdma-core/pull/62

I just got rdma-core built in Fedora rawhide today, and it'll be making the journey over to RHEL7 shortly as well. I'll be tracking upstream updates needed to sync up with what gets backported kernel-wise, so I suspect we'll have ample opportunity to pick up that fix for free once it's merged (thanks for doing that, btw).
Comment 6 Mike Stowell 2017-03-03 19:25:46 UTC 
Bug is marked ON_QA but looks like the patch hasn't gotten in to rdma-core-12-2.el7 yet.  `man ibv_rc_pingpong` still missing -m/-g/-o/-t options.

$ rpm -qf $(which ibv_rc_pingpong)
libibverbs-utils-12-2.el7.x86_64
$ man ibv_rc_pingpong 
<snip>
OPTIONS
       -p, --port=PORT
              use TCP port PORT for initial synchronization (default 18515)

       -d, --ib-dev=DEVICE
              use IB device DEVICE (default first device found)

       -i, --ib-port=PORT
              use IB port PORT (default port 1)

       -s, --size=SIZE
              ping-pong messages of size SIZE (default 4096)

       -r, --rx-depth=DEPTH
              post DEPTH receives at a time (default 1000)

       -n, --iters=ITERS
              perform ITERS message exchanges (default 1000)

       -l, --sl=SL
              use SL as the service level value of the QP (default 0)

       -e, --events
              sleep while waiting for work completion events (default is to poll for completions)
</snip>
Comment 7 Jarod Wilson 2017-03-03 23:58:24 UTC 
(In reply to Mike Stowell from comment #6)
> Bug is marked ON_QA but looks like the patch hasn't gotten in to
> rdma-core-12-2.el7 yet.  `man ibv_rc_pingpong` still missing -m/-g/-o/-t
> options.

D'oh, I thought it was merged upstream prior to the 12 release, hadn't actually checked. I'll have to cherry-pick that patch back into our build then.
Comment 8 Mike Stowell 2017-03-07 15:29:04 UTC 
Looks good now in libibverbs-utils-12-3.el7.x86_64 provided by rdma-core.  Will move to VERIFIED as soon as it hits ON_QA again.
Comment 9 Jarod Wilson 2017-03-07 16:45:05 UTC 
(In reply to Mike Stowell from comment #8)
> Looks good now in libibverbs-utils-12-3.el7.x86_64 provided by rdma-core. 
> Will move to VERIFIED as soon as it hits ON_QA again.

Whoops, forgot, I have to move it back to ON_QA, not to MODIFIED, since it's already in the erratum.
Comment 11 errata-xmlrpc 2017-08-01 16:57:45 UTC 
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHEA-2017:2011
Note You need to log in before you can comment on or make changes to this bug.