1 What: /sys/class/rtrs-client 1 What: /sys/class/rtrs-client
2 Date: Feb 2020 2 Date: Feb 2020
3 KernelVersion: 5.7 3 KernelVersion: 5.7
4 Contact: Jack Wang <jinpu.wang@cloud.ion 4 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
5 Description: When a user of RTRS API create 5 Description: When a user of RTRS API creates a new session, a directory entry with
6 the name of that session is cr 6 the name of that session is created under /sys/class/rtrs-client/<session-name>/
7 7
8 What: /sys/class/rtrs-client/<sessio 8 What: /sys/class/rtrs-client/<session-name>/add_path
9 Date: Feb 2020 9 Date: Feb 2020
10 KernelVersion: 5.7 10 KernelVersion: 5.7
11 Contact: Jack Wang <jinpu.wang@cloud.ion 11 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
12 Description: RW, adds a new path (connectio 12 Description: RW, adds a new path (connection) to an existing session. Expected format is the
13 following:: 13 following::
14 14
15 <[source addr,]destination 15 <[source addr,]destination addr>
16 *addr ::= [ ip:<ipv4|ipv6> 16 *addr ::= [ ip:<ipv4|ipv6> | gid:<gid> ]
17 17
18 What: /sys/class/rtrs-client/<sessio 18 What: /sys/class/rtrs-client/<session-name>/max_reconnect_attempts
19 Date: Feb 2020 19 Date: Feb 2020
20 KernelVersion: 5.7 20 KernelVersion: 5.7
21 Contact: Jack Wang <jinpu.wang@cloud.ion 21 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
22 Description: Maximum number reconnect attem 22 Description: Maximum number reconnect attempts the client should make before giving up
23 after connection breaks unexpe 23 after connection breaks unexpectedly.
24 24
25 What: /sys/class/rtrs-client/<sessio 25 What: /sys/class/rtrs-client/<session-name>/mp_policy
26 Date: Feb 2020 26 Date: Feb 2020
27 KernelVersion: 5.7 27 KernelVersion: 5.7
28 Contact: Jack Wang <jinpu.wang@cloud.ion 28 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
29 Description: Multipath policy specifies whi 29 Description: Multipath policy specifies which path should be selected on each IO:
30 30
31 round-robin (0): 31 round-robin (0):
32 select path in per CPU rou 32 select path in per CPU round-robin manner.
33 33
34 min-inflight (1): 34 min-inflight (1):
35 select path with minimum i 35 select path with minimum inflights.
36 36
37 min-latency (2): <<
38 select path with minimum l <<
39 <<
40 What: /sys/class/rtrs-client/<sessio 37 What: /sys/class/rtrs-client/<session-name>/paths/
41 Date: Feb 2020 38 Date: Feb 2020
42 KernelVersion: 5.7 39 KernelVersion: 5.7
43 Contact: Jack Wang <jinpu.wang@cloud.ion 40 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
44 Description: Each path belonging to a given 41 Description: Each path belonging to a given session is listed here by its source and
45 destination address. When a ne 42 destination address. When a new path is added to a session by writing to
46 the "add_path" entry, a direct< 43 the "add_path" entry, a directory <src@dst> is created.
47 44
48 What: /sys/class/rtrs-client/<session 45 What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/state
49 Date: Feb 2020 46 Date: Feb 2020
50 KernelVersion: 5.7 47 KernelVersion: 5.7
51 Contact: Jack Wang <jinpu.wang@cloud.ion 48 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
52 Description: RO, Contains "connected" if th 49 Description: RO, Contains "connected" if the session is connected to the peer and fully
53 functional. Otherwise the fil 50 functional. Otherwise the file contains "disconnected"
54 51
55 What: /sys/class/rtrs-client/<session 52 What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/reconnect
56 Date: Feb 2020 53 Date: Feb 2020
57 KernelVersion: 5.7 54 KernelVersion: 5.7
58 Contact: Jack Wang <jinpu.wang@cloud.ion 55 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
59 Description: Write "1" to the file in order 56 Description: Write "1" to the file in order to reconnect the path.
60 Operation is blocking and retu 57 Operation is blocking and returns 0 if reconnect was successful.
61 58
62 What: /sys/class/rtrs-client/<session 59 What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/disconnect
63 Date: Feb 2020 60 Date: Feb 2020
64 KernelVersion: 5.7 61 KernelVersion: 5.7
65 Contact: Jack Wang <jinpu.wang@cloud.ion 62 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
66 Description: Write "1" to the file in order 63 Description: Write "1" to the file in order to disconnect the path.
67 Operation blocks until RTRS pa 64 Operation blocks until RTRS path is disconnected.
68 65
69 What: /sys/class/rtrs-client/<session 66 What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/remove_path
70 Date: Feb 2020 67 Date: Feb 2020
71 KernelVersion: 5.7 68 KernelVersion: 5.7
72 Contact: Jack Wang <jinpu.wang@cloud.ion 69 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
73 Description: Write "1" to the file in order 70 Description: Write "1" to the file in order to disconnected and remove the path
74 from the session. Operation b 71 from the session. Operation blocks until the path is disconnected
75 and removed from the session. 72 and removed from the session.
76 73
77 What: /sys/class/rtrs-client/<session 74 What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/hca_name
78 Date: Feb 2020 75 Date: Feb 2020
79 KernelVersion: 5.7 76 KernelVersion: 5.7
80 Contact: Jack Wang <jinpu.wang@cloud.ion 77 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
81 Description: RO, Contains the name of HCA t !! 78 Description: RO, Contains the the name of HCA the connection established on.
82 79
83 What: /sys/class/rtrs-client/<session 80 What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/hca_port
84 Date: Feb 2020 81 Date: Feb 2020
85 KernelVersion: 5.7 82 KernelVersion: 5.7
86 Contact: Jack Wang <jinpu.wang@cloud.ion 83 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
87 Description: RO, Contains the port number o 84 Description: RO, Contains the port number of active port traffic is going through.
88 85
89 What: /sys/class/rtrs-client/<session 86 What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/src_addr
90 Date: Feb 2020 87 Date: Feb 2020
91 KernelVersion: 5.7 88 KernelVersion: 5.7
92 Contact: Jack Wang <jinpu.wang@cloud.ion 89 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
93 Description: RO, Contains the source addres 90 Description: RO, Contains the source address of the path
94 91
95 What: /sys/class/rtrs-client/<session 92 What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/dst_addr
96 Date: Feb 2020 93 Date: Feb 2020
97 KernelVersion: 5.7 94 KernelVersion: 5.7
98 Contact: Jack Wang <jinpu.wang@cloud.ion 95 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
99 Description: RO, Contains the destination a 96 Description: RO, Contains the destination address of the path
100 <<
101 What: /sys/class/rtrs-client/<session <<
102 Date: Feb 2020 <<
103 KernelVersion: 5.7 <<
104 Contact: Jack Wang <jinpu.wang@cloud.ion <<
105 Description: RO, Contains the latency time <<
106 Whenever the client sends hear <<
107 between sending the heart-beat <<
108 This value can be changed regu <<
109 97
110 What: /sys/class/rtrs-client/<session 98 What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/stats/reset_all
111 Date: Feb 2020 99 Date: Feb 2020
112 KernelVersion: 5.7 100 KernelVersion: 5.7
113 Contact: Jack Wang <jinpu.wang@cloud.ion 101 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
114 Description: RW, Read will return usage hel 102 Description: RW, Read will return usage help, write 0 will clear all the statistics.
115 103
116 What: /sys/class/rtrs-client/<session 104 What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/stats/cpu_migration
117 Date: Feb 2020 105 Date: Feb 2020
118 KernelVersion: 5.7 106 KernelVersion: 5.7
119 Contact: Jack Wang <jinpu.wang@cloud.ion 107 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
120 Description: RTRS expects that each HCA IRQ 108 Description: RTRS expects that each HCA IRQ is pinned to a separate CPU. If it's
121 not the case, the processing o 109 not the case, the processing of an I/O response could be processed on a
122 different CPU than where it wa 110 different CPU than where it was originally submitted. This file shows
123 how many interrupts where gene 111 how many interrupts where generated on a non expected CPU.
124 112
125 "from:" 113 "from:"
126 is the CPU on which the IR 114 is the CPU on which the IRQ was expected, but not generated.
127 "to:" 115 "to:"
128 is the CPU on which the IR 116 is the CPU on which the IRQ was generated, but not expected.
129 117
130 What: /sys/class/rtrs-client/<session 118 What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/stats/reconnects
131 Date: Feb 2020 119 Date: Feb 2020
132 KernelVersion: 5.7 120 KernelVersion: 5.7
133 Contact: Jack Wang <jinpu.wang@cloud.ion 121 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
134 Description: Contains 2 unsigned int values 122 Description: Contains 2 unsigned int values, the first one records number of successful
135 reconnects in the path lifetim 123 reconnects in the path lifetime, the second one records number of failed
136 reconnects in the path lifetim 124 reconnects in the path lifetime.
137 125
138 What: /sys/class/rtrs-client/<session 126 What: /sys/class/rtrs-client/<session-name>/paths/<src@dst>/stats/rdma
139 Date: Feb 2020 127 Date: Feb 2020
140 KernelVersion: 5.7 128 KernelVersion: 5.7
141 Contact: Jack Wang <jinpu.wang@cloud.ion 129 Contact: Jack Wang <jinpu.wang@cloud.ionos.com> Danil Kipnis <danil.kipnis@cloud.ionos.com>
142 Description: Contains statistics regarding 130 Description: Contains statistics regarding rdma operations and inflight operations.
143 The output consists of 6 value 131 The output consists of 6 values::
144 132
145 <read-count> <read-total-s 133 <read-count> <read-total-size> <write-count> \
146 <write-total-size> <inflig 134 <write-total-size> <inflights> <failovered>
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.