Skip to contentSkip to conversation

cachestat: a new syscall for page cache state of files

PATCH Superseded Nhat Pham 4 participants 8 messages Jan 26, 2023 – Jan 29, 2023

Subsystems (23)

v8 of 13 Superseded Latest is v13 →

lore
Share & tools
lore

Nhat Pham

author maintainer
#0 lore raw

v8 cover cachestat: a new syscall for page cache state of files

Changelog:
v8:
* Add syscall to mips syscall tables (detected by kernel test robot)

    (patch 2)
  * Add a missing return (suggested by Yu Zhao) (patch 2)
v7:
  * Fix and use lru_gen_test_recent (suggested by Brian Foster)
    (patch 2)

* Small formatting and organizational fixes
v6:
* Add a missing fdput() (suggested by Brian Foster) (patch 2)
* Replace cstat_size with cstat_version (suggested by Brian Foster)

    (patch 2)
  * Add conditional resched to the xas walk. (suggested by Hillf Danton) 
    (patch 2)

v5:
* Separate first patch into its own series. (suggested by Andrew Morton)
* Expose filemap_cachestat() to non-syscall usage (patch 2) (suggested by Brian Foster).
* Fix some build errors from last version.

    (patch 2)

* Explain eviction and recent eviction in the draft man page and documentation (suggested by Andrew Morton).
(patch 2)
v4:
* Refactor cachestat and move it to mm/filemap.c (patch 3) (suggested by Brian Foster)
* Remove redundant checks (!folio, access_ok)
(patch 3) (suggested by Matthew Wilcox and Al Viro)
* Fix a bug in handling multipages folio.
(patch 3) (suggested by Matthew Wilcox)
* Add a selftest for shmem files, which can be used to test huge pages (patch 4) (suggested by Johannes Weiner)
v3:
* Fix some minor formatting issues and build errors.
* Add the new syscall entry to missing architecture syscall tables.

    (patch 3).

* Add flags argument for the syscall. (patch 3).
* Clean up the recency refactoring (patch 2) (suggested by Yu Zhao)
* Add the new Kconfig (CONFIG_CACHESTAT) to disable the syscall. (patch 3) (suggested by Josh Triplett)
v2:
* len == 0 means query to EOF. len < 0 is invalid.
(patch 3) (suggested by Brian Foster)
* Make cachestat extensible by adding the cstat_size argument in the syscall (patch 3)

There is currently no good way to query the page cache state of large file sets and directory trees. There is mincore(), but it scales poorly:
the kernel writes out a lot of bitmap data that userspace has to aggregate, when the user really doesn not care about per-page information in that case. The user also needs to mmap and unmap each file as it goes along, which can be quite slow as well.

This series of patches introduces a new system call, cachestat, that summarizes the page cache statistics (number of cached pages, dirty pages, pages marked for writeback, evicted pages etc.) of a file, in a specified range of bytes. It also include a selftest suite that tests some typical usage

This interface is inspired by past discussion and concerns with fincore, which has a similar design (and as a result, issues) as mincore. Relevant links:

https://lkml.indiana.edu/hypermail/linux/kernel/1302.1/04207.html
https://lkml.indiana.edu/hypermail/linux/kernel/1302.1/04209.html

For comparison with mincore, I ran both syscalls on a 2TB sparse file:

Using mincore:

real    0m37.510s
user    0m2.934s
sys     0m34.558s

Using cachestat:

real    0m0.009s
user    0m0.000s
sys     0m0.009s

This series should be applied on top of:

workingset: fix confusion around eviction vs refault container
https://lkml.org/lkml/2023/1/4/1066

This series consist of 3 patches:

Nhat Pham (3):
workingset: refactor LRU refault to expose refault recency check
cachestat: implement cachestat syscall
selftests: Add selftests for cachestat

 MAINTAINERS                                   |   7 +
 arch/alpha/kernel/syscalls/syscall.tbl        |   1 +
 arch/arm/tools/syscall.tbl                    |   1 +
 arch/ia64/kernel/syscalls/syscall.tbl         |   1 +
 arch/m68k/kernel/syscalls/syscall.tbl         |   1 +
 arch/microblaze/kernel/syscalls/syscall.tbl   |   1 +
 arch/mips/kernel/syscalls/syscall_n32.tbl     |   1 +
 arch/mips/kernel/syscalls/syscall_n64.tbl     |   1 +
 arch/mips/kernel/syscalls/syscall_o32.tbl     |   1 +
 arch/parisc/kernel/syscalls/syscall.tbl       |   1 +
 arch/powerpc/kernel/syscalls/syscall.tbl      |   1 +
 arch/s390/kernel/syscalls/syscall.tbl         |   1 +
 arch/sh/kernel/syscalls/syscall.tbl           |   1 +
 arch/sparc/kernel/syscalls/syscall.tbl        |   1 +
 arch/x86/entry/syscalls/syscall_32.tbl        |   1 +
 arch/x86/entry/syscalls/syscall_64.tbl        |   1 +
 arch/xtensa/kernel/syscalls/syscall.tbl       |   1 +
 include/linux/fs.h                            |   3 +
 include/linux/swap.h                          |   1 +
 include/linux/syscalls.h                      |   4 +
 include/uapi/asm-generic/unistd.h             |   5 +-
 include/uapi/linux/mman.h                     |   9 +
 init/Kconfig                                  |  10 +
 kernel/sys_ni.c                               |   1 +
 mm/filemap.c                                  | 154 +++++++++++
 mm/workingset.c                               | 142 ++++++----
 tools/testing/selftests/Makefile              |   1 +
 tools/testing/selftests/cachestat/.gitignore  |   2 +
 tools/testing/selftests/cachestat/Makefile    |   8 +
 .../selftests/cachestat/test_cachestat.c      | 260 ++++++++++++++++++
 30 files changed, 576 insertions(+), 47 deletions(-)
 create mode 100644 tools/testing/selftests/cachestat/.gitignore
 create mode 100644 tools/testing/selftests/cachestat/Makefile
 create mode 100644 tools/testing/selftests/cachestat/test_cachestat.c

base-commit: 1440f576022887004f719883acb094e7e0dd4944
prerequisite-patch-id: 171a43d333e1b267ce14188a5beaea2f313787fb

Signature · 1 line
2.30.2
author maintainer
#1 lore raw

PATCH v8 1/3 workingset: refactor LRU refault to expose refault recency check

In preparation for computing recently evicted pages in cachestat, refactor workingset_refault and lru_gen_refault to expose a helper function that would test if an evicted page is recently evicted.

---
 include/linux/swap.h |   1 +
 mm/workingset.c      | 142 +++++++++++++++++++++++++++++--------------
 2 files changed, 97 insertions(+), 46 deletions(-)
include/linux/swap.h +1 -0
index a18cf4b7c724..dae6f6f955eb 100644
@@ -361,6 +361,7 @@ static inline void folio_set_swap_entry(struct folio *folio, swp_entry_t entry)
 }
 
 /* linux/mm/workingset.c */
+bool workingset_test_recent(void *shadow, bool file, bool *workingset);
 void workingset_age_nonresident(struct lruvec *lruvec, unsigned long nr_pages);
 void *workingset_eviction(struct folio *folio, struct mem_cgroup *target_memcg);
 void workingset_refault(struct folio *folio, void *shadow);
mm/workingset.c +96 -46

206 lines not on this page · raw message

Signature · 1 line
2.30.2
author maintainer
#2 lore raw

PATCH v8 2/3 cachestat: implement cachestat syscall

In reply to Nhat Pham

There is currently no good way to query the page cache state of large file sets and directory trees. There is mincore(), but it scales poorly:
the kernel writes out a lot of bitmap data that userspace has to aggregate, when the user really doesn not care about per-page information in that case. The user also needs to mmap and unmap each file as it goes along, which can be quite slow as well.

This patch implements a new syscall that queries cache state of a file and summarizes the number of cached pages, number of dirty pages, number of pages marked for writeback, number of (recently) evicted pages, etc. in a given range.

NAME
cachestat - query the page cache statistics of a file.

SYNOPSIS

    #include <sys/mman.h>

    struct cachestat {
        __u64 nr_cache;
        __u64 nr_dirty;
        __u64 nr_writeback;
        __u64 nr_evicted;
        __u64 nr_recently_evicted;
    };

    int cachestat(unsigned int fd, off_t off, size_t len,
          unsigned int cstat_version, struct cachestat *cstat,
          unsigned int flags);

DESCRIPTION
cachestat() queries the number of cached pages, number of dirty pages, number of pages marked for writeback, number of evicted pages, number of recently evicted pages, in the bytes range given by off and len.

An evicted page is a page that is previously in the page cache but has been evicted since. A page is recently evicted if its last eviction was recent enough that its reentry to the cache would indicate that it is actively being used by the system, and that there is memory pressure on the system.

These values are returned in a cachestat struct, whose address is given by the cstat argument.

The off and len arguments must be non-negative integers. If len > 0, the queried range is [off, off + len]. If len == 0, we will query in the range from off to the end of the file.

cstat_version is an unsigned integer indicating the specific version of the cachestat struct. It must be at least 1, and does not exceed the latest version number (which is currently 1). For now, user should just pass 1.

The flags argument is unused for now, but is included for future extensibility. User should pass 0 (i.e no flag specified).

RETURN VALUE
On success, cachestat returns 0. On error, -1 is returned, and errno is set to indicate the error.

ERRORS
EFAULT cstat points to an invalid address.

EINVAL invalid cstat_version or flags

EBADF invalid file descriptor.

---
 arch/alpha/kernel/syscalls/syscall.tbl      |   1 +
 arch/arm/tools/syscall.tbl                  |   1 +
 arch/ia64/kernel/syscalls/syscall.tbl       |   1 +
 arch/m68k/kernel/syscalls/syscall.tbl       |   1 +
 arch/microblaze/kernel/syscalls/syscall.tbl |   1 +
 arch/mips/kernel/syscalls/syscall_n32.tbl   |   1 +
 arch/mips/kernel/syscalls/syscall_n64.tbl   |   1 +
 arch/mips/kernel/syscalls/syscall_o32.tbl   |   1 +
 arch/parisc/kernel/syscalls/syscall.tbl     |   1 +
 arch/powerpc/kernel/syscalls/syscall.tbl    |   1 +
 arch/s390/kernel/syscalls/syscall.tbl       |   1 +
 arch/sh/kernel/syscalls/syscall.tbl         |   1 +
 arch/sparc/kernel/syscalls/syscall.tbl      |   1 +
 arch/x86/entry/syscalls/syscall_32.tbl      |   1 +
 arch/x86/entry/syscalls/syscall_64.tbl      |   1 +
 arch/xtensa/kernel/syscalls/syscall.tbl     |   1 +
 include/linux/fs.h                          |   3 +
 include/linux/syscalls.h                    |   4 +
 include/uapi/asm-generic/unistd.h           |   5 +-
 include/uapi/linux/mman.h                   |   9 ++
 init/Kconfig                                |  10 ++
 kernel/sys_ni.c                             |   1 +
 mm/filemap.c                                | 154 ++++++++++++++++++++
 23 files changed, 201 insertions(+), 1 deletion(-)
arch/alpha/kernel/syscalls/syscall.tbl +1 -0
index 8ebacf37a8cf..1f13995d00d7 100644
@@ -490,3 +490,4 @@
 558	common	process_mrelease		sys_process_mrelease
 559	common  futex_waitv                     sys_futex_waitv
 560	common	set_mempolicy_home_node		sys_ni_syscall
+561	common	cachestat			sys_cachestat
arch/arm/tools/syscall.tbl +1 -0
index ac964612d8b0..8ebed8a13874 100644
@@ -464,3 +464,4 @@
 448	common	process_mrelease		sys_process_mrelease
 449	common	futex_waitv			sys_futex_waitv
 450	common	set_mempolicy_home_node		sys_set_mempolicy_home_node
+451	common	cachestat			sys_cachestat
arch/ia64/kernel/syscalls/syscall.tbl +1 -0
index 72c929d9902b..f8c74ffeeefb 100644
@@ -371,3 +371,4 @@
 448	common	process_mrelease		sys_process_mrelease
 449	common  futex_waitv                     sys_futex_waitv
 450	common	set_mempolicy_home_node		sys_set_mempolicy_home_node
+451	common	cachestat			sys_cachestat
arch/m68k/kernel/syscalls/syscall.tbl +1 -0
index b1f3940bc298..4f504783371f 100644
@@ -450,3 +450,4 @@
 448	common	process_mrelease		sys_process_mrelease
 449	common  futex_waitv                     sys_futex_waitv
 450	common	set_mempolicy_home_node		sys_set_mempolicy_home_node
+451	common	cachestat			sys_cachestat
arch/microblaze/kernel/syscalls/syscall.tbl +1 -0
index 820145e47350..858d22bf275c 100644
@@ -456,3 +456,4 @@
 448	common	process_mrelease		sys_process_mrelease
 449	common  futex_waitv                     sys_futex_waitv
 450	common	set_mempolicy_home_node		sys_set_mempolicy_home_node
+451	common	cachestat			sys_cachestat
arch/mips/kernel/syscalls/syscall_n32.tbl +1 -0
index 253ff994ed2e..1976317d4e8b 100644
@@ -389,3 +389,4 @@
 448	n32	process_mrelease		sys_process_mrelease
 449	n32	futex_waitv			sys_futex_waitv
 450	n32	set_mempolicy_home_node		sys_set_mempolicy_home_node
+451	n32	cachestat			sys_cachestat
arch/mips/kernel/syscalls/syscall_n64.tbl +1 -0
index 3f1886ad9d80..cfda2511badf 100644
@@ -365,3 +365,4 @@
 448	n64	process_mrelease		sys_process_mrelease
 449	n64	futex_waitv			sys_futex_waitv
 450	common	set_mempolicy_home_node		sys_set_mempolicy_home_node
+451	n64	cachestat			sys_cachestat
arch/mips/kernel/syscalls/syscall_o32.tbl +1 -0
index 8f243e35a7b2..7692234c3768 100644
@@ -438,3 +438,4 @@
 448	o32	process_mrelease		sys_process_mrelease
 449	o32	futex_waitv			sys_futex_waitv
 450	o32	set_mempolicy_home_node		sys_set_mempolicy_home_node
+451	o32	cachestat			sys_cachestat
arch/parisc/kernel/syscalls/syscall.tbl +1 -0
index 8a99c998da9b..7c84a72306d1 100644
@@ -448,3 +448,4 @@
 448	common	process_mrelease		sys_process_mrelease
 449	common	futex_waitv			sys_futex_waitv
 450	common	set_mempolicy_home_node		sys_set_mempolicy_home_node
+451	common	cachestat			sys_cachestat
arch/powerpc/kernel/syscalls/syscall.tbl +1 -0
index 2bca64f96164..937460f0a8ec 100644
@@ -530,3 +530,4 @@
 448	common	process_mrelease		sys_process_mrelease
 449	common  futex_waitv                     sys_futex_waitv
 450 	nospu	set_mempolicy_home_node		sys_set_mempolicy_home_node
+451	common	cachestat			sys_cachestat
arch/s390/kernel/syscalls/syscall.tbl +1 -0
index 799147658dee..7df0329d46cb 100644
@@ -453,3 +453,4 @@
 448  common	process_mrelease	sys_process_mrelease		sys_process_mrelease
 449  common	futex_waitv		sys_futex_waitv			sys_futex_waitv
 450  common	set_mempolicy_home_node	sys_set_mempolicy_home_node	sys_set_mempolicy_home_node
+451  common	cachestat		sys_cachestat			sys_cachestat
arch/sh/kernel/syscalls/syscall.tbl +1 -0
index 2de85c977f54..97377e8c5025 100644
@@ -453,3 +453,4 @@
 448	common	process_mrelease		sys_process_mrelease
 449	common  futex_waitv                     sys_futex_waitv
 450	common	set_mempolicy_home_node		sys_set_mempolicy_home_node
+451	common	cachestat			sys_cachestat
arch/sparc/kernel/syscalls/syscall.tbl +1 -0
index 4398cc6fb68d..faa835f3c54a 100644
@@ -496,3 +496,4 @@
 448	common	process_mrelease		sys_process_mrelease
 449	common  futex_waitv                     sys_futex_waitv
 450	common	set_mempolicy_home_node		sys_set_mempolicy_home_node
+451	common	cachestat			sys_cachestat
arch/x86/entry/syscalls/syscall_32.tbl +1 -0
index 320480a8db4f..bc0a3c941b35 100644
@@ -455,3 +455,4 @@
 448	i386	process_mrelease	sys_process_mrelease
 449	i386	futex_waitv		sys_futex_waitv
 450	i386	set_mempolicy_home_node		sys_set_mempolicy_home_node
+451	i386	cachestat		sys_cachestat
arch/x86/entry/syscalls/syscall_64.tbl +1 -0
index c84d12608cd2..227538b0ce80 100644
@@ -372,6 +372,7 @@
 448	common	process_mrelease	sys_process_mrelease
 449	common	futex_waitv		sys_futex_waitv
 450	common	set_mempolicy_home_node	sys_set_mempolicy_home_node
+451	common	cachestat		sys_cachestat
 
 #
 # Due to a historical design error, certain syscalls are numbered differently
arch/xtensa/kernel/syscalls/syscall.tbl +1 -0
index 52c94ab5c205..2b69c3c035b6 100644
@@ -421,3 +421,4 @@
 448	common	process_mrelease		sys_process_mrelease
 449	common  futex_waitv                     sys_futex_waitv
 450	common	set_mempolicy_home_node		sys_set_mempolicy_home_node
+451	common	cachestat			sys_cachestat
include/linux/fs.h +3 -0
index e654435f1651..83300f1491e7 100644
@@ -75,6 +75,7 @@ struct fs_context;
 struct fs_parameter_spec;
 struct fileattr;
 struct iomap_ops;
+struct cachestat;
 
 extern void __init inode_init(void);
 extern void __init inode_init_early(void);
@@ -830,6 +831,8 @@ void filemap_invalidate_lock_two(struct address_space *mapping1,
 				 struct address_space *mapping2);
 void filemap_invalidate_unlock_two(struct address_space *mapping1,
 				   struct address_space *mapping2);
+void filemap_cachestat(struct address_space *mapping, pgoff_t first_index,
+		pgoff_t last_index, struct cachestat *cs);
 
 
 /*
include/linux/syscalls.h +4 -0
index a34b0f9a9972..d3fe6ba8eb38 100644
@@ -72,6 +72,7 @@ struct open_how;
 struct mount_attr;
 struct landlock_ruleset_attr;
 enum landlock_rule_type;
+struct cachestat;
 
 #include <linux/types.h>
 #include <linux/aio_abi.h>
@@ -1056,6 +1057,9 @@ asmlinkage long sys_memfd_secret(unsigned int flags);
 asmlinkage long sys_set_mempolicy_home_node(unsigned long start, unsigned long len,
 					    unsigned long home_node,
 					    unsigned long flags);
+asmlinkage long sys_cachestat(unsigned int fd, off_t off, size_t len,
+		unsigned int cstat_version, struct cachestat __user *cstat,
+		unsigned int flags);
 
 /*
  * Architecture-specific system calls
include/uapi/asm-generic/unistd.h +4 -1
index 45fa180cc56a..cd639fae9086 100644
@@ -886,8 +886,11 @@ __SYSCALL(__NR_futex_waitv, sys_futex_waitv)
 #define __NR_set_mempolicy_home_node 450
 __SYSCALL(__NR_set_mempolicy_home_node, sys_set_mempolicy_home_node)
 
+#define __NR_cachestat 451
+__SYSCALL(__NR_cachestat, sys_cachestat)
+
 #undef __NR_syscalls
-#define __NR_syscalls 451
+#define __NR_syscalls 452
 
 /*
  * 32 bit systems traditionally used different
include/uapi/linux/mman.h +9 -0
index f55bc680b5b0..fe03ed0b7587 100644
@@ -4,6 +4,7 @@
 
 #include <asm/mman.h>
 #include <asm-generic/hugetlb_encode.h>
+#include <linux/types.h>
 
 #define MREMAP_MAYMOVE		1
 #define MREMAP_FIXED		2
@@ -41,4 +42,12 @@
 #define MAP_HUGE_2GB	HUGETLB_FLAG_ENCODE_2GB
 #define MAP_HUGE_16GB	HUGETLB_FLAG_ENCODE_16GB
 
+struct cachestat {
+	__u64 nr_cache;
+	__u64 nr_dirty;
+	__u64 nr_writeback;
+	__u64 nr_evicted;
+	__u64 nr_recently_evicted;
+};
+
 #endif /* _UAPI_LINUX_MMAN_H */
init/Kconfig +10 -0
index 694f7c160c9c..da96ac29af1d 100644
@@ -1798,6 +1798,16 @@ config RSEQ
 
 	  If unsure, say Y.
 
+config CACHESTAT_SYSCALL
+	bool "Enable cachestat() system call" if EXPERT
+	default y
+	help
+	  Enable the cachestat system call, which queries the page cache
+	  statistics of a file (number of cached pages, dirty pages,
+	  pages marked for writeback, (recently) evicted pages).
+
+	  If unsure say Y here.
+
 config DEBUG_RSEQ
 	default n
 	bool "Enabled debugging of rseq() system call" if EXPERT
kernel/sys_ni.c +1 -0
index 860b2dcf3ac4..04bfb1e4d377 100644
@@ -299,6 +299,7 @@ COND_SYSCALL(set_mempolicy);
 COND_SYSCALL(migrate_pages);
 COND_SYSCALL(move_pages);
 COND_SYSCALL(set_mempolicy_home_node);
+COND_SYSCALL(cachestat);
 
 COND_SYSCALL(perf_event_open);
 COND_SYSCALL(accept4);
mm/filemap.c +154 -0

169 lines not on this page · raw message

Signature · 1 line
2.30.2
maintainer
#3 lore raw

Re: [PATCH v8 2/3] cachestat: implement cachestat syscall

Quoted 15 lines · Nhat Pham

SYNOPSIS

    #include <sys/mman.h>

    struct cachestat {
        __u64 nr_cache;
        __u64 nr_dirty;
        __u64 nr_writeback;
        __u64 nr_evicted;
        __u64 nr_recently_evicted;
    };

    int cachestat(unsigned int fd, off_t off, size_t len,
          unsigned int cstat_version, struct cachestat *cstat,
          unsigned int flags);

Is this "off_t off" argument intentionally limited to the old 32-bit type on 32-bit architectures? Unfortunately I fear there are no good options to pass an offset here:

- if you make it a 32-bit type, this breaks calling it from normal userspace that defines off_t as a 64-bit type

- if you change it to a 64-bit loff_t, there are three separate calling conventions for 64-bit, 32-bit with aligned register pairs and other 32-bit, plus you exceed the usual limit of six system call arguments

A separate problem may be the cstat_version argument, usually we don't use interface versions but instead use a new system call number if something changes in an incompatible way.

Arnd

maintainer
#4 lore raw

Re: [PATCH v8 2/3] cachestat: implement cachestat syscall

Quoted 21 lines · Arnd Bergmann
Quoted 15 lines · Nhat Pham

SYNOPSIS

    #include <sys/mman.h>

    struct cachestat {
        __u64 nr_cache;
        __u64 nr_dirty;
        __u64 nr_writeback;
        __u64 nr_evicted;
        __u64 nr_recently_evicted;
    };

    int cachestat(unsigned int fd, off_t off, size_t len,
          unsigned int cstat_version, struct cachestat *cstat,
          unsigned int flags);

Is this "off_t off" argument intentionally limited to the old 32-bit type on 32-bit architectures? Unfortunately I fear there are no good options to pass an offset here:

Quoted 7 lines

- if you make it a 32-bit type, this breaks calling it from normal userspace that defines off_t as a 64-bit type

- if you change it to a 64-bit loff_t, there are three separate calling conventions for 64-bit, 32-bit with aligned register pairs and other 32-bit, plus you exceed the usual limit of six system call arguments

That's a good point, thanks for raising it, Arnd.

Quoted 4 lines

A separate problem may be the cstat_version argument, usually we don't use interface versions but instead use a new system call number if something changes in an incompatible way.

I suppose from a userspace POV, a version argument vs calling a separate syscall doesn't make much of a difference. So going with loff_t and dropping cstat_version seems like a sensible way forward.

As an added bonus, versioning the syscall itself means the signature can change in v2. This allows dropping the unused flags arg for now.

That would leave it at:

  int cachestat(unsigned int, loff_t, size_t len, struct cachestat *cstat);

and should we ever require extensions - new fields, flags - they would come through a new cachestat2().

Would anybody have objections to that?

maintainer
#5 lore raw

Re: [PATCH v8 2/3] cachestat: implement cachestat syscall

Quoted 21 lines · Johannes Weiner
Quoted 8 lines · Arnd Bergmann

- if you make it a 32-bit type, this breaks calling it from normal userspace that defines off_t as a 64-bit type

- if you change it to a 64-bit loff_t, there are three separate calling conventions for 64-bit, 32-bit with aligned register pairs and other 32-bit, plus you exceed the usual limit of six system call arguments

That's a good point, thanks for raising it, Arnd.

Quoted 4 lines

A separate problem may be the cstat_version argument, usually we don't use interface versions but instead use a new system call number if something changes in an incompatible way.

I suppose from a userspace POV, a version argument vs calling a separate syscall doesn't make much of a difference. So going with loff_t and dropping cstat_version seems like a sensible way forward.

Quoted 6 lines

As an added bonus, versioning the syscall itself means the signature can change in v2. This allows dropping the unused flags arg for now.

That would leave it at:

  int cachestat(unsigned int, loff_t, size_t len, struct cachestat *cstat);

There is still a problem of incompatible calling conventions:
on architectures that require even/odd register pairs, this would end up like

int cachestat(unsigned int, long unused, u32 off_low, u32 off_high,

              size_t len, struct cachestat *cstat);

A more portable way to do this would be to pass the offset by reference, but that makes it a bit awkward in userspace.

Or the arguments could be rearranged to put the low/high argument pair first/second, third/fourth or fifth/sixth argument, at least on the kernel ABI to avoid having another situation like sys_arm_fadvise64_64.

Quoted 4 lines

and should we ever require extensions - new fields, flags - they would come through a new cachestat2().

Would anybody have objections to that?

If there is room for another argument, I would keep the 'flags' as a way for extending in a compatible way, that is pretty standard now, just not flags plus version.

Arnd

#6 lore raw

Re: [PATCH v8 2/3] cachestat: implement cachestat syscall

In reply to Nhat Pham
Thank you for the patch! Perhaps something to improve:

Hi Nhat,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on 1440f576022887004f719883acb094e7e0dd4944]

url:    https://github.com/intel-lab-lkp/linux/commits/Nhat-Pham/workingset-refactor-LRU-refault-to-expose-refault-recency-check/20230128-171134
base:   1440f576022887004f719883acb094e7e0dd4944
patch link:    https://lore.kernel.org/r/20230126175356.1582123-3-nphamcs%40gmail.com
patch subject: [PATCH v8 2/3] cachestat: implement cachestat syscall
config: s390-randconfig-s051-20230129 (https://download.01.org/0day-ci/archive/20230129/[email protected]/config)
compiler: s390-linux-gcc (GCC) 12.1.0

reproduce:
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# apt-get install sparse
# sparse version: v0.6.4-39-gce1a6720-dirty
# https://github.com/intel-lab-lkp/linux/commit/a05ffdcecfe9ac147066fb8472e6fb75491d0eed
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Nhat-Pham/workingset-refactor-LRU-refault-to-expose-refault-recency-check/20230128-171134 git checkout a05ffdcecfe9ac147066fb8472e6fb75491d0eed
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross C=1 CF='-fdiagnostic-prefix -D__CHECK_ENDIAN__' O=build_dir ARCH=s390 olddefconfig COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross C=1 CF='-fdiagnostic-prefix -D__CHECK_ENDIAN__' O=build_dir ARCH=s390 SHELL=/bin/bash

If you fix the issue, kindly add following tag where applicable | Reported-by: kernel test robot <[email protected]>

sparse warnings: (new ones prefixed by >>)

>> mm/filemap.c:4075:1: sparse: sparse: Using plain integer as NULL pointer
>> mm/filemap.c:4075:1: sparse: sparse: Using plain integer as NULL pointer

mm/filemap.c:1416:17: sparse: sparse: context imbalance in 'migration_entry_wait_on_locked' - unexpected unlock

vim +4075 mm/filemap.c

4037
4038 #ifdef CONFIG_CACHESTAT_SYSCALL
4039 /*
4040 * The cachestat(5) system call.
4041 *
4042 * cachestat() returns the page cache statistics of a file in the
4043 * bytes range specified by off and len: number of cached pages,
4044 * number of dirty pages, number of pages marked for writeback,
4045 * number of evicted pages, and number of recently evicted pages.
4046 *
4047 * An evicted page is a page that is previously in the page cache
4048 * but has been evicted since. A page is recently evicted if its last
4049 * eviction was recent enough that its reentry to the cache would
4050 * indicate that it is actively being used by the system, and that
4051 * there is memory pressure on the system.
4052 *
4053 * off and len must be non-negative integers. If len > 0,
4054 * the queried range is [off, off + len]. If len == 0,
4055 * we will query in the range from off to the end of the file.
4056 *
4057 * cstat_version is an unsigned integer indicating the specific version
4058 * of the cachestat struct. It must be at least 1, and does not exceed the
4059 * latest version number (which is currently 1). For now, user should
4060 * just pass 1.
4061 *
4062 * The flags argument is unused for now, but is included for future
4063 * extensibility. User should pass 0 (i.e no flag specified).
4064 *
4065 * Because the status of a page can change after cachestat() checks it
4066 * but before it returns to the application, the returned values may
4067 * contain stale information.
4068 *
4069 * return values:

  4070	 *  zero    - success
  4071	 *  -EFAULT - cstat points to an illegal address
  4072	 *  -EINVAL - invalid arguments
  4073	 *  -EBADF	- invalid file descriptor
  4074	 */
> 4075	SYSCALL_DEFINE6(cachestat, unsigned int, fd, off_t, off, size_t, len,
Signature · 2 lines
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests
author maintainer
#7 lore raw

PATCH v8 3/3 selftests: Add selftests for cachestat

In reply to Nhat Pham

Test cachestat on a newly created file, /dev/ files, and /proc/ files. Also test on a shmem file (which can also be tested with huge pages since tmpfs supports huge pages).

---
 MAINTAINERS                                   |   7 +
 tools/testing/selftests/Makefile              |   1 +
 tools/testing/selftests/cachestat/.gitignore  |   2 +
 tools/testing/selftests/cachestat/Makefile    |   8 +
 .../selftests/cachestat/test_cachestat.c      | 260 ++++++++++++++++++
 5 files changed, 278 insertions(+)
 create mode 100644 tools/testing/selftests/cachestat/.gitignore
 create mode 100644 tools/testing/selftests/cachestat/Makefile
 create mode 100644 tools/testing/selftests/cachestat/test_cachestat.c
MAINTAINERS +7 -0
index a198da986146..792a866353ec 100644
@@ -4552,6 +4552,13 @@ S:	Supported
 F:	Documentation/filesystems/caching/cachefiles.rst
 F:	fs/cachefiles/
 
+CACHESTAT: PAGE CACHE STATS FOR A FILE
+M:	Nhat Pham <[email protected]>
+M:	Johannes Weiner <[email protected]>
+L:	[email protected]
+S:	Maintained
+F:	tools/testing/selftests/cachestat/test_cachestat.c
+
 CADENCE MIPI-CSI2 BRIDGES
 M:	Maxime Ripard <[email protected]>
 L:	[email protected]
tools/testing/selftests/Makefile +1 -0
index 0464b2c6c1e4..3cad0b38c5c2 100644
@@ -4,6 +4,7 @@ TARGETS += amd-pstate
 TARGETS += arm64
 TARGETS += bpf
 TARGETS += breakpoints
+TARGETS += cachestat
 TARGETS += capabilities
 TARGETS += cgroup
 TARGETS += clone3
tools/testing/selftests/cachestat/.gitignore new file +2 -0
new file mode 100644
index 000000000000..d6c30b43a4bb
@@ -0,0 +1,2 @@
+# SPDX-License-Identifier: GPL-2.0-only
+test_cachestat
tools/testing/selftests/cachestat/Makefile new file +8 -0
new file mode 100644
index 000000000000..fca73aaa7d14
@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: GPL-2.0
+TEST_GEN_PROGS := test_cachestat
+
+CFLAGS += $(KHDR_INCLUDES)
+CFLAGS += -Wall
+CFLAGS += -lrt
+
+include ../lib.mk
tools/testing/selftests/cachestat/test_cachestat.c new file +260 -0

260 lines not on this page · raw message

Signature · 1 line
2.30.2