Commit 56eb2767 authored by Bagas Sanjaya's avatar Bagas Sanjaya Committed by Tejun Heo
Browse files

docs: cgroup-v1: replace custom note constructs with appropriate admonition blocks 



Admonition constructs on the documentation use definition lists, which
isn't fit for the purpose. Replace them with appropriate blocks:

  * Use caution:: for outdated document notice
  * hint:: for memo
  * note:: for other constructs
  * warning:: for memory reclaim

Signed-off-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: default avatarTejun Heo <tj@kernel.org>
parent 21786e5c

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

+31 −27
Original line number Diff line number Diff line
@@ -2,13 +2,13 @@ 
Memory Resource Controller

==========================



NOTE:

.. caution::

      This document is hopelessly outdated and it asks for a complete

      rewrite. It still contains a useful information so we are keeping it

      here but make sure to check the current code if you need a deeper

      understanding.



NOTE:

.. note::

      The Memory Resource Controller has generically been referred to as the

      memory controller in this document. Do not confuse memory controller

      used here with the memory controller that is used in hardware.
@@ -274,11 +274,11 @@ The reclaim algorithm has not been modified for cgroups, except that 
pages that are selected for reclaiming come from the per-cgroup LRU

list.



NOTE:

.. note::

   Reclaim does not work for the root cgroup, since we cannot set any

   limits on the root cgroup.



Note2:

.. note::

   When panic_on_oom is set to "2", the whole system will panic.



When oom event notifier is registered, event will be delivered.
@@ -367,10 +367,10 @@ U != 0, K < U: 
    never greater than the total memory, and freely set U at the cost of his

    QoS.



WARNING:

    In the current implementation, memory reclaim will NOT be

    triggered for a cgroup when it hits K while staying below U, which makes

    this setup impractical.

    .. warning::

       In the current implementation, memory reclaim will NOT be triggered for

       a cgroup when it hits K while staying below U, which makes this setup

       impractical.



U != 0, K >= U:

    Since kmem charges will also be fed to the user counter and reclaim will be
@@ -405,15 +405,15 @@ Since now we're in the 0 cgroup, we can alter the memory limit:: 


	# echo 4M > /sys/fs/cgroup/memory/0/memory.limit_in_bytes



NOTE:

.. note::

   We can use a suffix (k, K, m, M, g or G) to indicate values in kilo,

   mega or gigabytes. (Here, Kilo, Mega, Giga are Kibibytes, Mebibytes,

   Gibibytes.)



NOTE:

.. note::

   We can write "-1" to reset the ``*.limit_in_bytes(unlimited)``.



NOTE:

.. note::

   We cannot set limits on the root cgroup any more.



::
@@ -574,12 +574,12 @@ recent_scanned_anon VM internal parameter. (see mm/vmscan.c) 
recent_scanned_file	  VM internal parameter. (see mm/vmscan.c)

========================= ========================================



Memo:

.. hint::

	recent_rotated means recent frequency of LRU rotation.

	recent_scanned means recent # of scans to LRU.

	showing for better debug please see the code for meanings.



Note:

.. note::

	Only anonymous and swap cache memory is listed as part of 'rss' stat.

	This should not be confused with the true 'resident set size' or the

	amount of physical memory used by the cgroup.
@@ -710,10 +710,11 @@ If we want to change this to 1G, we can at any time use:: 


	# echo 1G > memory.soft_limit_in_bytes



NOTE1:

.. note::

       Soft limits take effect over a long period of time, since they involve

       reclaiming memory for balancing between memory cgroups

NOTE2:



.. note::

       It is recommended to set the soft limit always below the hard limit,

       otherwise the hard limit will take precedence.
@@ -735,17 +736,20 @@ If you want to enable it:: 


	# echo (some positive value) > memory.move_charge_at_immigrate



Note:

.. note::

      Each bits of move_charge_at_immigrate has its own meaning about what type

      of charges should be moved. See 8.2 for details.

Note:



.. note::

      Charges are moved only when you move mm->owner, in other words,

      a leader of a thread group.

Note:



.. note::

      If we cannot find enough space for the task in the destination cgroup, we

      try to make space by reclaiming memory. Task migration may fail if we

      cannot make enough space.

Note:



.. note::

      It can take several seconds if you move charges much.



And if you want disable it again::