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  rdma
11       link(8).)
12
13

DESCRIPTION

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

FILES

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

SEE ALSO

124       rdma(8), verbs(7),
125
126

AUTHORS

128       Written by John Groves, Frank Zago and Bob  Pearson  at  System  Fabric
129       Works.
130
131
132
1331.0.0                             2011-06-29                            RXE(7)
Impressum