forked from paravmellanox/rtool
-
Notifications
You must be signed in to change notification settings - Fork 0
/
rdma_mr_lat.1
90 lines (90 loc) · 1.91 KB
/
rdma_mr_lat.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
.TH RDMA_MR_LAT "1" "Aug 2017" "" "User Commands"
.SH NAME
rdma_mr_lat \- simple RDMA Memory registration latency monitoring tool
.SH SYNOPSYS
.SY rdma_mr_lat
.OP \-d device
.OP \-s size
.OP \-l align
.OP \-u huge
.br
.SY rdma_mr_lat
.B -h
|
.B -v
.br
.SH DESCRIPTION
This tool allocates and registers memory with RDMA devices and measures
latency in real time.
.SH OPTIONS
.TP
.BI \-l \ align
Set \fIalign\fR size in bytes to align this memory registration to.
.TP
.BI \-s \ size
Memory Region size (\fB4k\fR).
.TP
.BI \-h
Display help message and exit.
.TP
.B \-v
Display version and exit.
.TP
For options that expect "size" argument (\fB\-s\fR),
default is bytes, unless you specify one of the following suffixes
(case-insensitive):
.TP
.BR KiB ,\ k ,\ kb
kilobytes (1 024 bytes)
.TP
.BR MiB ,\ m ,\ mb
megabytes (1 048 576 bytes)
.TP
.BR GiB ,\ g ,\ gb
gigabytes (1 073 741 824 bytes)
.TP
.BR TiB ,\ t ,\ tb
terabytes (1 099 511 627 776 bytes)
.PP
For options that expect "number" argument (\fB-p\fR and \fB-c\fR) you
can optionally specify one of the following suffixes (case-insensitive):
.TP
.B k
kilo (thousands, 1 000)
.TP
.B m
mega (millions, 1 000 000)
.TP
.B g
giga (billions, 1 000 000 000)
.TP
.B t
tera (trillions, 1 000 000 000 000)
.SH EXIT STATUS
Returns \fB0\fR on success. The following error codes are defined:
.TP
.B 1
Invalid usage (error in command arguments).
.TP
.B other errors.
Error during runtime.
.SH EXAMPLES
.TP
.B rdma_mr_lat -d mlx5_0
Show RDMA memory registration latency using default size 4k for device mlx5_0.
.TP
.B rdma_mr_lat -d mlx5_0 -s 4G -u
Show RDMA memory registration latency using default size 4k for device mlx5_0.
It perform 4G bytes memory registration with huge pages.
.TP
.SH HOMEPAGE
.UR https://github.com/paravmellanox/rdma_mr_lat/
.UE .
.SH AUTHORS
This program was written by Parav Pandit
.ME .
.br
Man-page was written by Parav Pandit
.ME .