linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
From: "Aneesh Kumar K.V" <aneesh.kumar@linux.vnet.ibm.com>
To: linux-mm@kvack.org, kamezawa.hiroyu@jp.fujitsu.com,
	dhillf@gmail.com, rientjes@google.com, mhocko@suse.cz,
	akpm@linux-foundation.org, hannes@cmpxchg.org
Cc: linux-kernel@vger.kernel.org, cgroups@vger.kernel.org,
	"Aneesh Kumar K.V" <aneesh.kumar@linux.vnet.ibm.com>
Subject: [PATCH -V8 16/16] hugetlb/cgroup: add HugeTLB controller documentation
Date: Sat,  9 Jun 2012 14:30:01 +0530	[thread overview]
Message-ID: <1339232401-14392-17-git-send-email-aneesh.kumar@linux.vnet.ibm.com> (raw)
In-Reply-To: <1339232401-14392-1-git-send-email-aneesh.kumar@linux.vnet.ibm.com>

From: "Aneesh Kumar K.V" <aneesh.kumar@linux.vnet.ibm.com>

Signed-off-by: Aneesh Kumar K.V <aneesh.kumar@linux.vnet.ibm.com>
---
 Documentation/cgroups/hugetlb.txt |   45 +++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 Documentation/cgroups/hugetlb.txt

diff --git a/Documentation/cgroups/hugetlb.txt b/Documentation/cgroups/hugetlb.txt
new file mode 100644
index 0000000..a9faaca
--- /dev/null
+++ b/Documentation/cgroups/hugetlb.txt
@@ -0,0 +1,45 @@
+HugeTLB Controller
+-------------------
+
+The HugeTLB controller allows to limit the HugeTLB usage per control group and
+enforces the controller limit during page fault. Since HugeTLB doesn't
+support page reclaim, enforcing the limit at page fault time implies that,
+the application will get SIGBUS signal if it tries to access HugeTLB pages
+beyond its limit. This requires the application to know beforehand how much
+HugeTLB pages it would require for its use.
+
+HugeTLB controller can be created by first mounting the cgroup filesystem.
+
+# mount -t cgroup -o hugetlb none /sys/fs/cgroup
+
+With the above step, the initial or the parent HugeTLB group becomes
+visible at /sys/fs/cgroup. At bootup, this group includes all the tasks in
+the system. /sys/fs/cgroup/tasks lists the tasks in this cgroup.
+
+New groups can be created under the parent group /sys/fs/cgroup.
+
+# cd /sys/fs/cgroup
+# mkdir g1
+# echo $$ > g1/tasks
+
+The above steps create a new group g1 and move the current shell
+process (bash) into it.
+
+Brief summary of control files
+
+ hugetlb.<hugepagesize>.limit_in_bytes     # set/show limit of "hugepagesize" hugetlb usage
+ hugetlb.<hugepagesize>.max_usage_in_bytes # show max "hugepagesize" hugetlb  usage recorded
+ hugetlb.<hugepagesize>.usage_in_bytes     # show current res_counter usage for "hugepagesize" hugetlb
+ hugetlb.<hugepagesize>.failcnt		   # show the number of allocation failure due to HugeTLB limit
+
+For a system supporting two hugepage size (16M and 16G) the control
+files include:
+
+hugetlb.16GB.limit_in_bytes
+hugetlb.16GB.max_usage_in_bytes
+hugetlb.16GB.usage_in_bytes
+hugetlb.16GB.failcnt
+hugetlb.16MB.limit_in_bytes
+hugetlb.16MB.max_usage_in_bytes
+hugetlb.16MB.usage_in_bytes
+hugetlb.16MB.failcnt
-- 
1.7.10

--
To unsubscribe, send a message with 'unsubscribe linux-mm' in
the body to majordomo@kvack.org.  For more info on Linux MM,
see: http://www.linux-mm.org/ .
Don't email: <a href=mailto:"dont@kvack.org"> email@kvack.org </a>

  parent reply	other threads:[~2012-06-09  9:00 UTC|newest]

Thread overview: 71+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-06-09  8:59 [PATCH -V8 00/16] hugetlb: Add HugeTLB controller to control HugeTLB allocation Aneesh Kumar K.V
2012-06-09  8:59 ` [PATCH -V8 01/16] hugetlb: rename max_hstate to hugetlb_max_hstate Aneesh Kumar K.V
2012-06-09  8:59 ` [PATCH -V8 02/16] hugetlb: don't use ERR_PTR with VM_FAULT* values Aneesh Kumar K.V
2012-06-09 11:10   ` Konrad Rzeszutek Wilk
2012-06-09 13:17     ` Aneesh Kumar K.V
2012-06-09 19:28   ` KOSAKI Motohiro
2012-06-10  1:59   ` Hillf Danton
2012-06-09  8:59 ` [PATCH -V8 03/16] hugetlb: add an inline helper for finding hstate index Aneesh Kumar K.V
2012-06-09  8:59 ` [PATCH -V8 04/16] hugetlb: use mmu_gather instead of a temporary linked list for accumulating pages Aneesh Kumar K.V
2012-06-09  8:59 ` [PATCH -V8 05/16] hugetlb: avoid taking i_mmap_mutex in unmap_single_vma() for hugetlb Aneesh Kumar K.V
2012-06-09  9:44   ` Johannes Weiner
2012-06-09 13:03     ` Aneesh Kumar K.V
2012-06-09 14:49       ` Johannes Weiner
2012-06-09  8:59 ` [PATCH -V8 06/16] hugetlb: simplify migrate_huge_page() Aneesh Kumar K.V
2012-06-12  7:31   ` Kamezawa Hiroyuki
2012-06-09  8:59 ` [PATCH -V8 07/16] hugetlb: add a list for tracking in-use HugeTLB pages Aneesh Kumar K.V
2012-06-09  8:59 ` [PATCH -V8 08/16] hugetlb: Make some static variables global Aneesh Kumar K.V
2012-06-12  7:35   ` Kamezawa Hiroyuki
2012-06-09  8:59 ` [PATCH -V8 09/16] mm/hugetlb: Add new HugeTLB cgroup Aneesh Kumar K.V
2012-06-12  7:46   ` Kamezawa Hiroyuki
2012-06-12  9:37     ` Aneesh Kumar K.V
2012-06-09  8:59 ` [PATCH -V8 10/16] hugetlb/cgroup: Add the cgroup pointer to page lru Aneesh Kumar K.V
2012-06-09 11:14   ` Konrad Rzeszutek Wilk
2012-06-09 17:04   ` Aneesh Kumar K.V
2012-06-11  8:16   ` Michal Hocko
2012-06-11  9:03     ` Aneesh Kumar K.V
2012-06-11  9:16       ` Michal Hocko
2012-06-11  9:33         ` Aneesh Kumar K.V
2012-06-11  8:41   ` Kamezawa Hiroyuki
2012-06-12  7:52   ` Kamezawa Hiroyuki
2012-06-12  9:40     ` Aneesh Kumar K.V
2012-06-09  8:59 ` [PATCH -V8 11/16] hugetlb/cgroup: Add charge/uncharge routines for hugetlb cgroup Aneesh Kumar K.V
2012-06-11  8:38   ` Michal Hocko
2012-06-11  9:10     ` Michal Hocko
2012-06-11  9:28     ` Aneesh Kumar K.V
2012-06-11 12:59       ` Michal Hocko
2012-06-11 15:35         ` Aneesh Kumar K.V
2012-06-12  8:08   ` Kamezawa Hiroyuki
2012-06-12 10:50     ` Aneesh Kumar K.V
2012-06-13 11:02       ` Kamezawa Hiroyuki
2012-06-09  8:59 ` [PATCH -V8 12/16] hugetlb/cgroup: Add support for cgroup removal Aneesh Kumar K.V
2012-06-11  8:52   ` Michal Hocko
2012-06-11  9:40     ` Aneesh Kumar K.V
2012-06-11 13:14       ` Michal Hocko
2012-06-11 15:34         ` Aneesh Kumar K.V
2012-06-12  8:23   ` Kamezawa Hiroyuki
2012-06-12 10:52     ` Aneesh Kumar K.V
2012-06-09  8:59 ` [PATCH -V8 13/16] hugetlb/cgroup: add hugetlb cgroup control files Aneesh Kumar K.V
2012-06-09 11:19   ` Konrad Rzeszutek Wilk
2012-06-11  9:02   ` Michal Hocko
2012-06-11  9:43     ` Aneesh Kumar K.V
2012-06-11 13:15       ` Michal Hocko
2012-06-12  8:35   ` Kamezawa Hiroyuki
2012-06-12 10:58     ` Aneesh Kumar K.V
2012-06-13  0:16       ` Kamezawa Hiroyuki
2012-06-09  8:59 ` [PATCH -V8 14/16] hugetlb/cgroup: add charge/uncharge calls for HugeTLB alloc/free Aneesh Kumar K.V
2012-06-09  9:23   ` Johannes Weiner
2012-06-09 13:09     ` Aneesh Kumar K.V
2012-06-09 14:30       ` Johannes Weiner
2012-06-09 15:55         ` Aneesh Kumar K.V
2012-06-11  9:19         ` Michal Hocko
2012-06-11  9:21   ` Michal Hocko
2012-06-11 10:29     ` Aneesh Kumar K.V
2012-06-09  9:00 ` [PATCH -V8 15/16] hugetlb/cgroup: migrate hugetlb cgroup info from oldpage to new page during migration Aneesh Kumar K.V
2012-06-11  9:24   ` Michal Hocko
2012-06-11 10:17     ` Aneesh Kumar K.V
2012-06-12  8:51   ` Kamezawa Hiroyuki
2012-06-12 11:00     ` Aneesh Kumar K.V
2012-06-13 11:15       ` Kamezawa Hiroyuki
2012-06-09  9:00 ` Aneesh Kumar K.V [this message]
2012-06-12  8:57   ` [PATCH -V8 16/16] hugetlb/cgroup: add HugeTLB controller documentation Kamezawa Hiroyuki

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1339232401-14392-17-git-send-email-aneesh.kumar@linux.vnet.ibm.com \
    --to=aneesh.kumar@linux.vnet.ibm.com \
    --cc=akpm@linux-foundation.org \
    --cc=cgroups@vger.kernel.org \
    --cc=dhillf@gmail.com \
    --cc=hannes@cmpxchg.org \
    --cc=kamezawa.hiroyu@jp.fujitsu.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=mhocko@suse.cz \
    --cc=rientjes@google.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox