From: Yosry Ahmed <hidden> Date: 2022-04-21 23:44:46
This patch series adds a memory.reclaim proactive reclaim interface.
The rationale behind the interface and how it works are in the first
patch.
---
Changes in V4:
mm/memcontrol.c:
- Return -EINTR on signal_pending().
- On the final retry, drain percpu lru caches hoping that it might
introduce some evictable pages for reclaim.
- Simplified the retry loop as suggested by Dan Schatzberg.
selftests:
- Always return -errno on failure from cg_write() (whether open() or
write() fail), also update cg_read() and read_text() to return -errno
as well for consistency. Also make sure to correctly check that the
whole buffer was written in cg_write().
- Added a maximum number of retries for the reclaim selftest.
Changes in V3:
- Fix cg_write() (in patch 2) to properly return -1 if open() fails
and not fail if len == errno.
- Remove debug printf() in patch 3.
Changes in V2:
- Add the interface to root as well.
- Added a selftest.
- Documented the interface as a nested-keyed interface, which makes
adding optional arguments in the future easier (see doc updates in the
first patch).
- Modified the commit message to reflect changes and added a timeout
argument as a suggested possible extension
- Return -EAGAIN if the kernel fails to reclaim the full requested
amount.
---
Shakeel Butt (1):
memcg: introduce per-memcg reclaim interface
Yosry Ahmed (3):
selftests: cgroup: return -errno from cg_read()/cg_write() on failure
selftests: cgroup: fix alloc_anon_noexit() instantly freeing memory
selftests: cgroup: add a selftest for memory.reclaim
Documentation/admin-guide/cgroup-v2.rst | 21 +++++
mm/memcontrol.c | 44 +++++++++
tools/testing/selftests/cgroup/cgroup_util.c | 44 ++++-----
.../selftests/cgroup/test_memcontrol.c | 94 ++++++++++++++++++-
4 files changed, 176 insertions(+), 27 deletions(-)
--
2.36.0.rc2.479.g8af0fa9b8e-goog
From: Yosry Ahmed <hidden> Date: 2022-04-21 23:44:52
From: Shakeel Butt <redacted>
Introduce a memcg interface to trigger memory reclaim on a memory cgroup.
Use case: Proactive Reclaim
---------------------------
A userspace proactive reclaimer can continuously probe the memcg to
reclaim a small amount of memory. This gives more accurate and
up-to-date workingset estimation as the LRUs are continuously
sorted and can potentially provide more deterministic memory
overcommit behavior. The memory overcommit controller can provide
more proactive response to the changing behavior of the running
applications instead of being reactive.
A userspace reclaimer's purpose in this case is not a complete replacement
for kswapd or direct reclaim, it is to proactively identify memory savings
opportunities and reclaim some amount of cold pages set by the policy
to free up the memory for more demanding jobs or scheduling new jobs.
A user space proactive reclaimer is used in Google data centers.
Additionally, Meta's TMO paper recently referenced a very similar
interface used for user space proactive reclaim:
https://dl.acm.org/doi/pdf/10.1145/3503222.3507731
Benefits of a user space reclaimer:
-----------------------------------
1) More flexible on who should be charged for the cpu of the memory
reclaim. For proactive reclaim, it makes more sense to be centralized.
2) More flexible on dedicating the resources (like cpu). The memory
overcommit controller can balance the cost between the cpu usage and
the memory reclaimed.
3) Provides a way to the applications to keep their LRUs sorted, so,
under memory pressure better reclaim candidates are selected. This also
gives more accurate and uptodate notion of working set for an
application.
Why memory.high is not enough?
------------------------------
- memory.high can be used to trigger reclaim in a memcg and can
potentially be used for proactive reclaim.
However there is a big downside in using memory.high. It can potentially
introduce high reclaim stalls in the target application as the
allocations from the processes or the threads of the application can hit
the temporary memory.high limit.
- Userspace proactive reclaimers usually use feedback loops to decide
how much memory to proactively reclaim from a workload. The metrics
used for this are usually either refaults or PSI, and these metrics
will become messy if the application gets throttled by hitting the
high limit.
- memory.high is a stateful interface, if the userspace proactive
reclaimer crashes for any reason while triggering reclaim it can leave
the application in a bad state.
- If a workload is rapidly expanding, setting memory.high to proactively
reclaim memory can result in actually reclaiming more memory than
intended.
The benefits of such interface and shortcomings of existing interface
were further discussed in this RFC thread:
https://lore.kernel.org/linux-mm/5df21376-7dd1-bf81-8414-32a73cea45dd-hpIqsD4AKlfQT0dZR+AlfA@public.gmane.org/
Interface:
----------
Introducing a very simple memcg interface 'echo 10M > memory.reclaim' to
trigger reclaim in the target memory cgroup.
The interface is introduced as a nested-keyed file to allow for future
optional arguments to be easily added to configure the behavior of
reclaim.
Possible Extensions:
--------------------
- This interface can be extended with an additional parameter or flags
to allow specifying one or more types of memory to reclaim from (e.g.
file, anon, ..).
- The interface can also be extended with a node mask to reclaim from
specific nodes. This has use cases for reclaim-based demotion in memory
tiering systens.
- A similar per-node interface can also be added to support proactive
reclaim and reclaim-based demotion in systems without memcg.
- Add a timeout parameter to make it easier for user space to call the
interface without worrying about being blocked for an undefined amount
of time.
For now, let's keep things simple by adding the basic functionality.
[yosryahmed-hpIqsD4AKlfQT0dZR+AlfA@public.gmane.org: refreshed to current master, updated commit
message based on recent discussions and use cases]
Signed-off-by: Shakeel Butt <redacted>
Signed-off-by: Yosry Ahmed <redacted>
Acked-by: Johannes Weiner <redacted>
Acked-by: Michal Hocko <mhocko-IBi9RG/b67k@public.gmane.org>
Acked-by: Wei Xu <redacted>
Acked-by: Roman Gushchin <redacted>
---
Documentation/admin-guide/cgroup-v2.rst | 21 ++++++++++++
mm/memcontrol.c | 44 +++++++++++++++++++++++++
2 files changed, 65 insertions(+)
@@ -1208,6 +1208,27 @@ PAGE_SIZE multiple when read back. high limit is used and monitored properly, this limit's utility is limited to providing the final safety net.+ memory.reclaim+ A write-only nested-keyed file which exists for all cgroups.++ This is a simple interface to trigger memory reclaim in the+ target cgroup.++ This file accepts a single key, the number of bytes to reclaim.+ No nested keys are currently supported.++ Example::++ echo "1G" > memory.reclaim++ The interface can be later extended with nested keys to+ configure the reclaim behavior. For example, specify the+ type of memory to reclaim from (anon, file, ..).++ Please note that the kernel can over or under reclaim from+ the target cgroup. If less bytes are reclaimed than the+ specified amount, -EAGAIN is returned.+ memory.oom.group A read-write single value file which exists on non-root cgroups. The default value is "0".
@@ -6355,6 +6355,45 @@ static ssize_t memory_oom_group_write(struct kernfs_open_file *of,returnnbytes;}+staticssize_tmemory_reclaim(structkernfs_open_file*of,char*buf,+size_tnbytes,loff_toff)+{+structmem_cgroup*memcg=mem_cgroup_from_css(of_css(of));+unsignedintnr_retries=MAX_RECLAIM_RETRIES;+unsignedlongnr_to_reclaim,nr_reclaimed=0;+interr;++buf=strstrip(buf);+err=page_counter_memparse(buf,"",&nr_to_reclaim);+if(err)+returnerr;++while(nr_reclaimed<nr_to_reclaim){+unsignedlongreclaimed;++if(signal_pending(current))+return-EINTR;++/* This is the final attempt, drain percpu lru caches in the+*hopeofintroducingmoreevictablepagesfor+*try_to_free_mem_cgroup_pages().+*/+if(!nr_retries)+lru_add_drain_all();++reclaimed=try_to_free_mem_cgroup_pages(memcg,+nr_to_reclaim-nr_reclaimed,+GFP_KERNEL,true);++if(!reclaimed&&!nr_retries--)+return-EAGAIN;++nr_reclaimed+=reclaimed;+}++returnnbytes;+}+staticstructcftypememory_files[]={{.name="current",
From: Yosry Ahmed <hidden> Date: 2022-04-21 23:45:03
Add a new test for memory.reclaim that verifies that the interface
correctly reclaims memory as intended, from both anon and file pages.
Signed-off-by: Yosry Ahmed <redacted>
Acked-by: Roman Gushchin <roman.gushchin@linux.dev>
---
.../selftests/cgroup/test_memcontrol.c | 86 +++++++++++++++++++
1 file changed, 86 insertions(+)
@@ -760,6 +760,91 @@ static int test_memcg_max(const char *root)returnret;}+/*+*Thistestchecksthatmemory.reclaimreclaimsthegiven+*amountofmemory(frombothanonandfile).+*/+staticinttest_memcg_reclaim(constchar*root)+{+intret=KSFT_FAIL,fd,retries;+char*memcg;+longcurrent,to_reclaim;+charbuf[64];++memcg=cg_name(root,"memcg_test");+if(!memcg)+gotocleanup;++if(cg_create(memcg))+gotocleanup;++current=cg_read_long(memcg,"memory.current");+if(current!=0)+gotocleanup;++cg_run_nowait(memcg,alloc_anon_noexit,(void*)MB(50));+sleep(1);++fd=get_temp_fd();+if(fd<0)+gotocleanup;++cg_run_nowait(memcg,alloc_pagecache_50M_noexit,(void*)(long)fd);+sleep(1);++current=cg_read_long(memcg,"memory.current");+if(!values_close(current,MB(100),10))+gotocleanup;++/*+*Reclaimuntilcurrentreaches30M,makesuretoreclaimover50Mto+*hitbothanonandfile.+*/+retries=5;+while(true){+interr;++current=cg_read_long(memcg,"memory.current");+to_reclaim=current-MB(30);++/*+*WeonlykeeploopingifwegetEAGAIN,whichmeanswecould+*notreclaimthefullamount.+*/+if(to_reclaim<=0)+gotocleanup;+++snprintf(buf,sizeof(buf),"%ld",to_reclaim);+err=cg_write(memcg,"memory.reclaim",buf);+if(!err){+/*+*Ifwritingsucceeds,thenthewrittenamountshouldhavebeen+*fullyreclaimed(andmaybemore).+*/+current=cg_read_long(memcg,"memory.current");+if(!values_close(current,MB(30),3)&¤t>MB(30))+gotocleanup;+break;+}++/* The kernel could not reclaim the full amount, try again. */+if(err==-EAGAIN&&retries--)+continue;++/* We got an unexpected error or ran out of retries. */+gotocleanup;+}++ret=KSFT_PASS;+cleanup:+cg_destroy(memcg);+free(memcg);+close(fd);++returnret;+}+staticintalloc_anon_50M_check_swap(constchar*cgroup,void*arg){longmem_max=(long)arg;
From: Yosry Ahmed <hidden> Date: 2022-04-21 23:45:09
Currently, alloc_anon_noexit() calls alloc_anon() which instantly frees
the allocated memory. alloc_anon_noexit() is usually used with
cg_run_nowait() to run a process in the background that allocates
memory. It makes sense for the background process to keep the memory
allocated and not instantly free it (otherwise there is no point of
running it in the background).
Signed-off-by: Yosry Ahmed <redacted>
Acked-by: Roman Gushchin <redacted>
---
tools/testing/selftests/cgroup/test_memcontrol.c | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
From: Yosry Ahmed <hidden> Date: 2022-04-21 23:45:13
Currently, cg_read()/cg_write() returns 0 on success and -1 on failure.
Modify them to return the -errno on failure.
Signed-off-by: Yosry Ahmed <redacted>
---
tools/testing/selftests/cgroup/cgroup_util.c | 44 +++++++++-----------
1 file changed, 19 insertions(+), 25 deletions(-)
@@ -19,6 +19,7 @@#include"cgroup_util.h"#include"../clone3/clone3_selftests.h"+/* Returns read len on success, or -errno on failure. */staticssize_tread_text(constchar*path,char*buf,size_tmax_len){ssize_tlen;
@@ -26,35 +27,29 @@ static ssize_t read_text(const char *path, char *buf, size_t max_len)fd=open(path,O_RDONLY);if(fd<0)-returnfd;+return-errno;len=read(fd,buf,max_len-1);-if(len<0)-gotoout;-buf[len]=0;-out:+if(len>=0)+buf[len]=0;+close(fd);-returnlen;+returnlen<0?-errno:len;}+/* Returns written len on success, or -errno on failure. */staticssize_twrite_text(constchar*path,char*buf,ssize_tlen){intfd;fd=open(path,O_WRONLY|O_APPEND);if(fd<0)-returnfd;+return-errno;len=write(fd,buf,len);-if(len<0){-close(fd);-returnlen;-}-close(fd);--returnlen;+returnlen<0?-errno:len;}char*cg_name(constchar*root,constchar*name)
@@ -87,16 +82,16 @@ char *cg_control(const char *cgroup, const char *control)returnret;}+/* Returns 0 on success, or -errno on failure. */intcg_read(constchar*cgroup,constchar*control,char*buf,size_tlen){charpath[PATH_MAX];+ssize_tret;snprintf(path,sizeof(path),"%s/%s",cgroup,control);-if(read_text(path,buf,len)>=0)-return0;--return-1;+ret=read_text(path,buf,len);+returnret>=0?0:ret;}intcg_read_strcmp(constchar*cgroup,constchar*control,
@@ -177,17 +172,15 @@ long cg_read_lc(const char *cgroup, const char *control)returncnt;}+/* Returns 0 on success, or -errno on failure. */intcg_write(constchar*cgroup,constchar*control,char*buf){charpath[PATH_MAX];-ssize_tlen=strlen(buf);+ssize_tlen=strlen(buf),ret;snprintf(path,sizeof(path),"%s/%s",cgroup,control);--if(write_text(path,buf,len)==len)-return0;--return-1;+ret=write_text(path,buf,len);+returnret==len?0:ret;}intcg_find_unified_root(char*root,size_tlen)
On Thu, Apr 21, 2022 at 11:44:23PM +0000, Yosry Ahmed wrote:
From: Shakeel Butt <redacted>
[...]
[yosryahmed@google.com: refreshed to current master, updated commit
message based on recent discussions and use cases]
Signed-off-by: Shakeel Butt <redacted>
Signed-off-by: Yosry Ahmed <redacted>
You should add "Co-developed-by" tag for yourself here.
Acked-by: Johannes Weiner <hannes@cmpxchg.org>
Acked-by: Michal Hocko <mhocko@suse.com>
Acked-by: Wei Xu <weixugc@google.com>
Acked-by: Roman Gushchin <roman.gushchin@linux.dev>
---
[...]
quoted hunk
+static ssize_t memory_reclaim(struct kernfs_open_file *of, char *buf,+ size_t nbytes, loff_t off)+{+ struct mem_cgroup *memcg = mem_cgroup_from_css(of_css(of));+ unsigned int nr_retries = MAX_RECLAIM_RETRIES;+ unsigned long nr_to_reclaim, nr_reclaimed = 0;+ int err;++ buf = strstrip(buf);+ err = page_counter_memparse(buf, "", &nr_to_reclaim);+ if (err)+ return err;++ while (nr_reclaimed < nr_to_reclaim) {+ unsigned long reclaimed;++ if (signal_pending(current))+ return -EINTR;++ /* This is the final attempt, drain percpu lru caches in the
Fix the comment format. "/*" should be on its own line.
quoted hunk
+ * hope of introducing more evictable pages for+ * try_to_free_mem_cgroup_pages().+ */
No need to send a new version if Andrew can fix these in the mm tree.
On Thu, Apr 21, 2022 at 11:44:24PM +0000, Yosry Ahmed wrote:
Currently, cg_read()/cg_write() returns 0 on success and -1 on failure.
Modify them to return the -errno on failure.
Signed-off-by: Yosry Ahmed <redacted>
On Thu, Apr 21, 2022 at 11:44:25PM +0000, Yosry Ahmed wrote:
Currently, alloc_anon_noexit() calls alloc_anon() which instantly frees
the allocated memory. alloc_anon_noexit() is usually used with
cg_run_nowait() to run a process in the background that allocates
memory. It makes sense for the background process to keep the memory
allocated and not instantly free it (otherwise there is no point of
running it in the background).
Signed-off-by: Yosry Ahmed <redacted>
Acked-by: Roman Gushchin <redacted>
On Thu, Apr 21, 2022 at 11:44:26PM +0000, Yosry Ahmed wrote:
quoted hunk
Add a new test for memory.reclaim that verifies that the interface
correctly reclaims memory as intended, from both anon and file pages.
Signed-off-by: Yosry Ahmed <redacted>
Acked-by: Roman Gushchin <roman.gushchin@linux.dev>
---
.../selftests/cgroup/test_memcontrol.c | 86 +++++++++++++++++++
1 file changed, 86 insertions(+)
These sleep(1)s do not seem robust. Since kernel keeps the page cache
around, you can convert anon to use tmpfs and use simple cg_run to
trigger the allocations of anon (tmpfs) and file which will remain in
memory even after return from cg_run.
From: Yosry Ahmed <hidden> Date: 2022-04-23 21:43:56
On Sat, Apr 23, 2022 at 7:28 AM Shakeel Butt [off-list ref] wrote:
On Thu, Apr 21, 2022 at 11:44:26PM +0000, Yosry Ahmed wrote:
quoted
Add a new test for memory.reclaim that verifies that the interface
correctly reclaims memory as intended, from both anon and file pages.
Signed-off-by: Yosry Ahmed <redacted>
Acked-by: Roman Gushchin <roman.gushchin@linux.dev>
---
.../selftests/cgroup/test_memcontrol.c | 86 +++++++++++++++++++
1 file changed, 86 insertions(+)
These sleep(1)s do not seem robust. Since kernel keeps the page cache
around, you can convert anon to use tmpfs and use simple cg_run to
trigger the allocations of anon (tmpfs) and file which will remain in
memory even after return from cg_run.
Other tests in the file are also using sleep approach (see
test_memcg_min, although it retries for multiple times until
memory.current reaches an expected amount). In my experience it hasn't
been flaky running for multiple times on different machines, but I
agree it can be flaky (false negative).
I am not sure about the allocating file pages with cg_run, is it
guaranteed that the page cache will remain in memory until the test
ends? If it doesn't, it can also flake, but it would produce false
positives (the test could pass because the kernel drained page cache
for some other reason although the interface is not working
correctly).
In my personal opinion, false negative flakes are better than false
positives. At least currently the test explicitly and clearly fails if
the allocations are not successful. If we rely on the page cache
remaining until the test finishes then it could silently pass if the
interface is not working correctly.
There are a few ways we can go forward with this:
1) Keep everything as-is, but print a message if the test fails due to
memory.current not reaching 100MB to make it clear that it didn't fail
due to a problem with the interface.
2) Add a sleep/retry loop similar to test_memcg_min instead of sleeping once.
3) Send a signal from forked children when they are done with the
allocation, and wait to receive this signal in the test to make sure
the allocation is completed.
In my opinion we should do (1) (and maybe (2)) for now as (3) could be
an overkill if the test is normal passing. Maybe add a comment about
(3) being an option in the future if the test flakes. Let me know what
you think?
From: Yosry Ahmed <hidden> Date: 2022-04-23 21:45:01
On Sat, Apr 23, 2022 at 6:30 AM Shakeel Butt [off-list ref] wrote:
On Thu, Apr 21, 2022 at 11:44:23PM +0000, Yosry Ahmed wrote:
quoted
From: Shakeel Butt <redacted>
[...]
quoted
[yosryahmed@google.com: refreshed to current master, updated commit
message based on recent discussions and use cases]
Signed-off-by: Shakeel Butt <redacted>
Signed-off-by: Yosry Ahmed <redacted>
You should add "Co-developed-by" tag for yourself here.
quoted
Acked-by: Johannes Weiner <hannes@cmpxchg.org>
Acked-by: Michal Hocko <mhocko@suse.com>
Acked-by: Wei Xu <weixugc@google.com>
Acked-by: Roman Gushchin <roman.gushchin@linux.dev>
---
[...]
quoted
+static ssize_t memory_reclaim(struct kernfs_open_file *of, char *buf,+ size_t nbytes, loff_t off)+{+ struct mem_cgroup *memcg = mem_cgroup_from_css(of_css(of));+ unsigned int nr_retries = MAX_RECLAIM_RETRIES;+ unsigned long nr_to_reclaim, nr_reclaimed = 0;+ int err;++ buf = strstrip(buf);+ err = page_counter_memparse(buf, "", &nr_to_reclaim);+ if (err)+ return err;++ while (nr_reclaimed < nr_to_reclaim) {+ unsigned long reclaimed;++ if (signal_pending(current))+ return -EINTR;++ /* This is the final attempt, drain percpu lru caches in the
Fix the comment format. "/*" should be on its own line.
quoted
+ * hope of introducing more evictable pages for+ * try_to_free_mem_cgroup_pages().+ */
No need to send a new version if Andrew can fix these in the mm tree.
I will be sending v5 anyway to address your review comments on the
last patch. I will fix these as well. Thanks!
These sleep(1)s do not seem robust. Since kernel keeps the page cache
around, you can convert anon to use tmpfs and use simple cg_run to
trigger the allocations of anon (tmpfs) and file which will remain in
memory even after return from cg_run.
Other tests in the file are also using sleep approach (see
test_memcg_min, although it retries for multiple times until
memory.current reaches an expected amount). In my experience it hasn't
been flaky running for multiple times on different machines, but I
agree it can be flaky (false negative).
If other tests are doing the same then ignore this comment for now.
There should be a separate effort to move towards more deterministic
approach for the tests instead of sleep().
I am not sure about the allocating file pages with cg_run, is it
guaranteed that the page cache will remain in memory until the test
ends? If it doesn't, it can also flake, but it would produce false
positives (the test could pass because the kernel drained page cache
for some other reason although the interface is not working
correctly).
In my personal opinion, false negative flakes are better than false
positives. At least currently the test explicitly and clearly fails if
the allocations are not successful. If we rely on the page cache
remaining until the test finishes then it could silently pass if the
interface is not working correctly.
There are a few ways we can go forward with this:
1) Keep everything as-is, but print a message if the test fails due to
memory.current not reaching 100MB to make it clear that it didn't fail
due to a problem with the interface.
2) Add a sleep/retry loop similar to test_memcg_min instead of sleeping once.
3) Send a signal from forked children when they are done with the
allocation, and wait to receive this signal in the test to make sure
the allocation is completed.
In my opinion we should do (1) (and maybe (2)) for now as (3) could be
an overkill if the test is normal passing. Maybe add a comment about
(3) being an option in the future if the test flakes. Let me know what
you think?