rxe(7) - f31

1RXE(7)                 Miscellaneous Information Manual                 RXE(7)
2
3
4

NAME

6       rxe - Software RDMA over Ethernet
7

SYNOPSIS

9       modprobe rdma_rxe
10       This is usually performed by a configuration utility (see rxe_cfg(8).)
11
12

DESCRIPTION

14       The  rdma_rxe  kernel  module provides a software implementation of the
15       RoCEv2 protocol. The RoCEv2 protocol is an RDMA transport protocol that
16       exists  on top of UDP/IPv4 or UDP/IPv6. The InfiniBand (IB) Base Trans‐
17       port Header (BTH) is encapsulated in the UDP packet.
18
19       Once a RXE instance has been created, communicating via RXE is the same
20       as communicating via any OFED compatible Infiniband HCA, albeit in some
21       cases with addressing implications.
22
23       In particular, while the use of a GRH header is optional within IB sub‐
24       nets,  it  is  mandatory with RoCE.  Verbs applications written over IB
25       verbs should work seamlessly, but  they  require  provisioning  of  GRH
26       information  when  creating address vectors. The library and driver are
27       modified to provide for mapping from GID to MAC addresses  required  by
28       the hardware.
29
30

FILES

32       /sys/class/infiniband/rxe[0,1,...]
33              Directory  that holds RDMA device information. The format is the
34              same as other RDMA devices.
35
36
37       /sys/module/rdma_rxe_net/parameters/add
38              Write only file used by rxe_cfg(8) to add  new  RXE  devices  to
39              existing Ethernet devices.
40
41
42       /sys/module/rdma_rxe_net/parameters/remove
43              Write only file used by rxe_cfg(8) to remove RXE devices.
44
45
46       /sys/module/rdma_rxe_net/parameters/mtu
47              Write  only file used by rxe_cfg(8) to configure RoCE and Ether‐
48              net MTU values.
49
50
51       /sys/module/rdma_rxe/parameters/max_ucontext
52              Read/Write file that sets a limit on the number of  UCs  allowed
53              per RXE device.
54
55
56       /sys/module/rdma_rxe/parameters/max_qp
57              Read/Write  file  that sets a limit on the number of QPs allowed
58              per RXE device.
59
60
61       /sys/module/rdma_rxe/parameters/max_qp_wr
62              Read/Write file that sets a limit on the number of  WRs  per  QP
63              allowed per RXE device.
64
65
66       /sys/module/rdma_rxe/parameters/max_mr
67              Read/Write  file  that sets a limit on the number of MRs allowed
68              per RXE device.
69
70
71       /sys/module/rdma_rxe/parameters/max_fmr
72              Read/Write file that sets a limit on the number of FMRs  allowed
73              per RXE device.
74
75
76       /sys/module/rdma_rxe/parameters/max_cq
77              Read/Write  file  that sets a limit on the number of CQs allowed
78              per RXE device.
79
80
81       /sys/module/rdma_rxe/parameters/max_log_cqe
82              Read/Write file that sets a limit on the log base 2 of the  num‐
83              ber of CQEs per CQ allowed per RXE device.
84
85
86       /sys/module/rdma_rxe/parameters/max_inline_data
87              Read/Write  file  that  sets  a  limit  on the maximum amount of
88              inline data per WR allowed per RXE device.
89
90              The  above  configuration  parameters  only  affect  a  new  RXE
91              instance when it is created not afterwards.
92
93
94       /sys/module/rdma_rxe/parameters/crc_disable
95              Read/Write file that controls the disabling of ICRC computation.
96              Set to a nonzero value for TRUE. Zero for FALSE.
97
98
99       /sys/module/rdma_rxe/parameters/fast_comp|req|resp|arb
100              Read/Write file that enables calling kernel tasklets as  subrou‐
101              tines to reduce latency.
102
103
104       /sys/module/rdma_rxe/parameters/nsec_per_packet|kbyte
105              Read/Write  file  that  controls  static  rate pacing for output
106              packets. If set to nonzero values the minimum delay to the  next
107              packet  is  set  to  nsec_per_kbyte  *  sizeof(current packet in
108              KBytes) or nsec_per_packet which ever is less.
109
110
111       /sys/module/rdma_rxe/parameters/max_packet_per_ack
112              Read/Write file that controls the issuing of acks by the respon‐
113              der during a long message. If set additional acks will be gener‐
114              ated every max_pkt_per_ack packets.
115
116
117       /sys/module/rdma_rxe/parameters/max_skb_per_qp
118              Read/Write file that controls the number of skbs (packets)  that
119              a requester can queue for sending internally.
120
121
122       /sys/module/rdma_rxe/parameters/max_req_comp_gap
123              Read/Write file that controls the maximum gap between the PSN of
124              request packets send and ack packets received.
125
126
127       /sys/module/rdma_rxe/parameters/default_mtu
128              Read/Write file that controls the default mtu used for UD  pack‐
129              ets.
130
131

AUTHORS

137       Written  by  John  Groves,  Frank Zago and Bob Pearson at System Fabric
138       Works.
139
140
141
1421.0.0                             2011-06-29                            RXE(7)

NAME

SYNOPSIS

DESCRIPTION

FILES

SEE ALSO

AUTHORS