Skip to content

Commit 451a746

Browse files
Guopeng Zhanghtejun
authored andcommitted
Docs/admin-guide/cgroup-v1: document rdma.peak, rdma.events and rdma.events.local
The v1 RDMA controller documentation only describes rdma.max and rdma.current, but the controller exposes three more files -- rdma.peak, rdma.events and rdma.events.local -- which are already documented for v2. Mirror the v2 wording so the v1 documentation matches the files actually visible on a v1 mount. Co-developed-by: Tao Cui <cuitao@kylinos.cn> Signed-off-by: Tao Cui <cuitao@kylinos.cn> Signed-off-by: Guopeng Zhang <zhangguopeng@kylinos.cn> Signed-off-by: Tejun Heo <tj@kernel.org>
1 parent 5aa31cb commit 451a746

1 file changed

Lines changed: 66 additions & 0 deletions

File tree

  • Documentation/admin-guide/cgroup-v1

Documentation/admin-guide/cgroup-v1/rdma.rst

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ RDMA Controller
99
1-2. Why RDMA controller needed?
1010
1-3. How is RDMA controller implemented?
1111
2. Usage Examples
12+
3. RDMA Interface Files
1213
1314
1. Overview
1415
===========
@@ -115,3 +116,68 @@ Following resources can be accounted by rdma controller.
115116
(d) Delete resource limit::
116117

117118
echo mlx4_0 hca_handle=max hca_object=max > /sys/fs/cgroup/rdma/1/rdma.max
119+
120+
3. RDMA Interface Files
121+
========================
122+
123+
The following interface files are available in each non-root RDMA cgroup.
124+
125+
rdma.max
126+
A read-write file which describes the configured resource limit
127+
for an RDMA/IB device. See the Usage Examples above.
128+
129+
rdma.current
130+
A read-only file which describes the current resource usage.
131+
132+
rdma.peak
133+
A read-only nested-keyed file which shows the historical high
134+
watermark of resource usage per device since the cgroup was created.
135+
136+
An example for mlx4 and ocrdma device follows::
137+
138+
mlx4_0 hca_handle=1 hca_object=20
139+
ocrdma1 hca_handle=0 hca_object=23
140+
141+
rdma.events
142+
A read-only nested-keyed file which exists on non-root cgroups
143+
and contains the following keys:
144+
145+
max
146+
The number of times a process in this cgroup or its
147+
descendants attempted an RDMA resource allocation that
148+
was rejected because a rdma.max limit in the subtree
149+
was reached. This is a hierarchical counter propagated
150+
upward to all ancestor cgroups. A value change in this
151+
file generates a file modified event.
152+
153+
alloc_fail
154+
The number of RDMA resource allocation attempts that
155+
originated in this cgroup or its descendants and failed
156+
due to a rdma.max limit being reached. This is a
157+
hierarchical counter propagated upward.
158+
159+
An example for mlx4 device follows::
160+
161+
mlx4_0 hca_handle.max=5 hca_handle.alloc_fail=3 hca_object.max=0 hca_object.alloc_fail=0
162+
163+
rdma.events.local
164+
Similar to rdma.events but the fields are local to the cgroup,
165+
i.e. not hierarchical. The file modified event generated on this
166+
file reflects only the local events.
167+
168+
The following nested keys are defined.
169+
170+
max
171+
The number of times a process in this cgroup or its
172+
descendants attempted an RDMA resource allocation that
173+
was rejected because this cgroup's own rdma.max limit
174+
was reached.
175+
176+
alloc_fail
177+
The number of RDMA resource allocation attempts
178+
originating from this cgroup that failed due to this
179+
cgroup's or an ancestor's rdma.max limit.
180+
181+
An example for mlx4 device follows::
182+
183+
mlx4_0 hca_handle.max=5 hca_handle.alloc_fail=0 hca_object.max=0 hca_object.alloc_fail=0

0 commit comments

Comments
 (0)