1RXE_CFG(8) System Manager's Manual RXE_CFG(8)
2
6 rxe_cfg - rxe configuration tool for RXE (Soft RoCE)
7
9 rxe_cfg [status]
10 rxe_cfg start [-p proto]
11 rxe_cfg stop
12 rxe_cfg persistent
13 rxe_cfg add [-n] ethN
14 rxe_cfg remove [-n] ethN|rxeN
15 rxe_cfg crc enable|disable
16 rxe_cfg mtu [-f] [rxeN] mtu_size
17
19 rxe_cfg is the configuration tool for the RXE software implementation
20 of the RoCE protocol.
21 The RXE kernel modules are loaded, configured, reconfigured and
23 unloaded via the various rxe_cfg command options, documented below.
24
27 proto Ethertype field. Default value is 0x8915. This value must be
28 changed to use RXE on Mellanox ConnectX adapters.
29 ethN Network device name as listed in /sys/class/net. Only Ethernet
32 devices are supported; ie. eth0 or eth0.1234 for VLANs.
33 rxeN RXE device name as listed in /sys/class/infiniband/. Examples
36 are rxe0 or rxe1.
37 mtu_size
40 RoCE mtu. For RoCE the mtu represents the payload excluding
41 headers and has the possible values: 256, 512, 1024, 2048 and
42 4096.
43
46 [status]
47 The status command prints a table of information on available
48 Ethernet devices and configured RXE instances. The status dis‐
49 play is the default if no options are provided.
50 start [-p proto]
53 The start command loads the RXE modules and configures any per‐
54 sistent instances. If the -p proto option is included, the RXE
55 modules will be configured to use Ethertype = proto. (This
56 allows testing RXE on devices, like Mellanox ConnectX, that
57 already support the default RoCE Ethertype in hardware.)
58 stop The stop command unconfigures all RXE instances and attempts to
61 unload the kernel modules.
62 persistent
65 The persistent command prints the list of Ethernet devices for
66 which a RXE instance is persistently configured.
67 add [-n] ethN
70 The add command will configure a RXE instance on Ethernet device
71 ethN (e.g. eth0). The RXE modules must have already been loaded
72 via rxe_cfg start.
73 The default behavior is to add ethN to a file of persistent con‐
75 figurations and the same RXE device will be configured the next
76 time that rxe_cfg start is run. If the -n option is included
77 the device is not added to the persistence file.
78 remove [-n] ethN|rxeN
81 The remove command will remove the specified RXE instance. The
82 parameter must match a currently active ethN or rxeN name.
83 If the -n option is included the RXE device will be removed but
85 not removed from the persistent state. So it will be recreated
86 the next time that rxe_cfg start is run.
87 mtu [-f] [rxeN] mtu_size
90 The mtu command will set the RoCE MTU of all RXE devices to
91 mtu_size, provided that the underlying Ethernet MTU is suffi‐
92 ciently large. If the Ethernet MTU is not large enough, RXE
93 will use the largest MTU that fits; the driver remembers the
94 requested RoCE MTU and will increase the currently active MTU if
95 the Ethernet MTU is later changed up to the requested MTU.
96 If the -f option is included the underlying Ethernet MTUs will
98 be increased if necessary to the minimum size to accommodate a
99 RoCE MTU of size.
100 If a rxeN instance is specified then only that instance will be
102 affected by the command.
103 crc enable|disable
106 The crc command will enable or disable RoCE ICRC calculation.
107 Valid ICRCs are be required to communicate hardware RoCE NICs,
108 but when a RXE instance is communicating with another RXE
109 instance the performance will be better with the CRC disabled.
110 This option is global to all RXE instances.
112
115 [PREFIX]/etc/rxe.conf
116 RXE configuration file. Contains the list of persistent RXE
117 instances. All persistent RXE instances can be removed by
118 deleting this file (note this will take effect on the next
119 "rxe_cfg start" -- to remove actively configured instances, you
120 must "rxe_cfg stop").
121
124 rxe(7),
125
127 Written by John Groves, Frank Zago and Bob Pearson at System Fabric
128 Works.
1291.0.0 2011-06-29 RXE_CFG(8)