Skip to content

Commit b9d2a17

Browse files
bagasmehtejun
authored andcommitted
docs: cgroup-v1: use bullet lists for list of stat file tables
The stat file section contains three tables, where the leading texts for them are subsection heading. Organize them in the bullet list, while demoting headings into normal text. Signed-off-by: Bagas Sanjaya <[email protected]> Signed-off-by: Tejun Heo <[email protected]>
1 parent f7423bb commit b9d2a17

File tree

1 file changed

+53
-54
lines changed

1 file changed

+53
-54
lines changed

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

Lines changed: 53 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -519,60 +519,59 @@ will be charged as a new owner of it.
519519
5.2 stat file
520520
-------------
521521

522-
memory.stat file includes following statistics
523-
524-
per-memory cgroup local status
525-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
526-
527-
=============== ===============================================================
528-
cache # of bytes of page cache memory.
529-
rss # of bytes of anonymous and swap cache memory (includes
530-
transparent hugepages).
531-
rss_huge # of bytes of anonymous transparent hugepages.
532-
mapped_file # of bytes of mapped file (includes tmpfs/shmem)
533-
pgpgin # of charging events to the memory cgroup. The charging
534-
event happens each time a page is accounted as either mapped
535-
anon page(RSS) or cache page(Page Cache) to the cgroup.
536-
pgpgout # of uncharging events to the memory cgroup. The uncharging
537-
event happens each time a page is unaccounted from the cgroup.
538-
swap # of bytes of swap usage
539-
dirty # of bytes that are waiting to get written back to the disk.
540-
writeback # of bytes of file/anon cache that are queued for syncing to
541-
disk.
542-
inactive_anon # of bytes of anonymous and swap cache memory on inactive
543-
LRU list.
544-
active_anon # of bytes of anonymous and swap cache memory on active
545-
LRU list.
546-
inactive_file # of bytes of file-backed memory and MADV_FREE anonymous memory(
547-
LazyFree pages) on inactive LRU list.
548-
active_file # of bytes of file-backed memory on active LRU list.
549-
unevictable # of bytes of memory that cannot be reclaimed (mlocked etc).
550-
=============== ===============================================================
551-
552-
status considering hierarchy (see memory.use_hierarchy settings)
553-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
554-
555-
========================= ===================================================
556-
hierarchical_memory_limit # of bytes of memory limit with regard to hierarchy
557-
under which the memory cgroup is
558-
hierarchical_memsw_limit # of bytes of memory+swap limit with regard to
559-
hierarchy under which memory cgroup is.
560-
561-
total_<counter> # hierarchical version of <counter>, which in
562-
addition to the cgroup's own value includes the
563-
sum of all hierarchical children's values of
564-
<counter>, i.e. total_cache
565-
========================= ===================================================
566-
567-
The following additional stats are dependent on CONFIG_DEBUG_VM
568-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
569-
570-
========================= ========================================
571-
recent_rotated_anon VM internal parameter. (see mm/vmscan.c)
572-
recent_rotated_file VM internal parameter. (see mm/vmscan.c)
573-
recent_scanned_anon VM internal parameter. (see mm/vmscan.c)
574-
recent_scanned_file VM internal parameter. (see mm/vmscan.c)
575-
========================= ========================================
522+
memory.stat file includes following statistics:
523+
524+
* per-memory cgroup local status
525+
526+
=============== ===============================================================
527+
cache # of bytes of page cache memory.
528+
rss # of bytes of anonymous and swap cache memory (includes
529+
transparent hugepages).
530+
rss_huge # of bytes of anonymous transparent hugepages.
531+
mapped_file # of bytes of mapped file (includes tmpfs/shmem)
532+
pgpgin # of charging events to the memory cgroup. The charging
533+
event happens each time a page is accounted as either mapped
534+
anon page(RSS) or cache page(Page Cache) to the cgroup.
535+
pgpgout # of uncharging events to the memory cgroup. The uncharging
536+
event happens each time a page is unaccounted from the
537+
cgroup.
538+
swap # of bytes of swap usage
539+
dirty # of bytes that are waiting to get written back to the disk.
540+
writeback # of bytes of file/anon cache that are queued for syncing to
541+
disk.
542+
inactive_anon # of bytes of anonymous and swap cache memory on inactive
543+
LRU list.
544+
active_anon # of bytes of anonymous and swap cache memory on active
545+
LRU list.
546+
inactive_file # of bytes of file-backed memory and MADV_FREE anonymous
547+
memory (LazyFree pages) on inactive LRU list.
548+
active_file # of bytes of file-backed memory on active LRU list.
549+
unevictable # of bytes of memory that cannot be reclaimed (mlocked etc).
550+
=============== ===============================================================
551+
552+
* status considering hierarchy (see memory.use_hierarchy settings):
553+
554+
========================= ===================================================
555+
hierarchical_memory_limit # of bytes of memory limit with regard to
556+
hierarchy
557+
under which the memory cgroup is
558+
hierarchical_memsw_limit # of bytes of memory+swap limit with regard to
559+
hierarchy under which memory cgroup is.
560+
561+
total_<counter> # hierarchical version of <counter>, which in
562+
addition to the cgroup's own value includes the
563+
sum of all hierarchical children's values of
564+
<counter>, i.e. total_cache
565+
========================= ===================================================
566+
567+
* additional vm parameters (depends on CONFIG_DEBUG_VM):
568+
569+
========================= ========================================
570+
recent_rotated_anon VM internal parameter. (see mm/vmscan.c)
571+
recent_rotated_file VM internal parameter. (see mm/vmscan.c)
572+
recent_scanned_anon VM internal parameter. (see mm/vmscan.c)
573+
recent_scanned_file VM internal parameter. (see mm/vmscan.c)
574+
========================= ========================================
576575

577576
.. hint::
578577
recent_rotated means recent frequency of LRU rotation.

0 commit comments

Comments
 (0)