Skip to contentSkip to conversation

cachestat: a new syscall for page cache state of files

PATCH Superseded Nhat Pham 3 participants 11 messages Feb 3, 2023 – Feb 13, 2023

Subsystems (12)
Memory management x86 VFS Kselftest +8 more subsystems

v9 of 13 Superseded Latest is v13 →

lore
Share & tools
lore

Nhat Pham

author maintainer
#0 lore raw

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

Changelog:
v9:
* Remove syscall from all the architectures syscall table except x86

    (patch 2)

* API change: handle different cases for offset and add compat syscall. (patch 2) (suggested by Johannes Weiner and Arnd Bergmann)
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. Currently, the syscall is only wired in for x86 architecture.

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/x86/entry/syscalls/syscall_32.tbl        |   1 +
 arch/x86/entry/syscalls/syscall_64.tbl        |   1 +
 include/linux/compat.h                        |   4 +-
 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                                  | 157 +++++++++++
 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      | 256 ++++++++++++++++++
 17 files changed, 564 insertions(+), 48 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 v9 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 v9 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. Currently, the syscall is only wired in for x86 architecture.

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, loff_t off, size_t len,
        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.

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 offset or flags.

EBADF invalid file descriptor.

---
 arch/x86/entry/syscalls/syscall_32.tbl |   1 +
 arch/x86/entry/syscalls/syscall_64.tbl |   1 +
 include/linux/compat.h                 |   4 +-
 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                           | 157 +++++++++++++++++++++++++
 10 files changed, 193 insertions(+), 2 deletions(-)
arch/x86/entry/syscalls/syscall_32.tbl +1 -0
index 320480a8db4f..01d1cc009250 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		compat_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
include/linux/compat.h +3 -1
index 594357881b0b..353d3ce657a7 100644
@@ -816,7 +816,9 @@ asmlinkage long compat_sys_sendmsg(int fd, struct compat_msghdr __user *msg,
 asmlinkage long compat_sys_recvmsg(int fd, struct compat_msghdr __user *msg,
 				   unsigned int flags);
 
-/* mm/filemap.c: No generic prototype for readahead */
+/* mm/filemap.c */
+asmlinkage long compat_sys_cachestat(int fd, compat_arg_u64(off),
+		size_t len, struct cachestat __user *cstat, unsigned int flags);
 
 /* security/keys/keyctl.c */
 asmlinkage long compat_sys_keyctl(u32 option,
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..f92f25d96286 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, unsigned long off_low,
+		unsigned long off_high, size_t len, struct cachestat __user *cstat,
+		unsigned int flags);
 
 /*
  * Architecture-specific system calls
include/uapi/asm-generic/unistd.h +4 -1
index 45fa180cc56a..dc5fcfee7f09 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
+__SC_COMP(__NR_cachestat, sys_cachestat, compat_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 +157 -0

172 lines not on this page · raw message

Signature · 1 line
2.30.2
#3 lore raw

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

Thank you for the patch! Yet something to improve:

Hi Nhat,

Thank you for the patch! Yet something to improve:

[auto build test ERROR on 1440f576022887004f719883acb094e7e0dd4944]

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

reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# https://github.com/intel-lab-lkp/linux/commit/49a57ed71ac2c005231660c85c3f30c4b47d8b7b
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/20230204-030455 git checkout 49a57ed71ac2c005231660c85c3f30c4b47d8b7b
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross W=1 O=build_dir ARCH=alpha olddefconfig COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross W=1 O=build_dir ARCH=alpha SHELL=/bin/bash

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

All errors (new ones prefixed by >>):

mm/filemap.c:4035:6: warning: no previous prototype for 'ksys_cachestat' [-Wmissing-prototypes]
4035 | long ksys_cachestat(unsigned int fd, loff_t off, size_t len,
| ^~~~~~~~~~~~~~
In file included from mm/filemap.c:25:

>> include/linux/syscalls.h:243:25: error: conflicting types for 'sys_cachestat'; have 'long int(unsigned int,  loff_t,  size_t,  struct cachestat *, unsigned int)' {aka 'long int(unsigned int,  long long int,  long unsigned int,  struct cachestat *, unsigned int)'}
     243 |         asmlinkage long sys##name(__MAP(x,__SC_DECL,__VA_ARGS__))       \
         |                         ^~~
   include/linux/syscalls.h:229:9: note: in expansion of macro '__SYSCALL_DEFINEx'
     229 |         __SYSCALL_DEFINEx(x, sname, __VA_ARGS__)
         |         ^~~~~~~~~~~~~~~~~
   include/linux/syscalls.h:222:36: note: in expansion of macro 'SYSCALL_DEFINEx'
     222 | #define SYSCALL_DEFINE5(name, ...) SYSCALL_DEFINEx(5, _##name, __VA_ARGS__)
         |                                    ^~~~~~~~~~~~~~~

mm/filemap.c:4095:1: note: in expansion of macro 'SYSCALL_DEFINE5'
4095 | SYSCALL_DEFINE5(cachestat, unsigned int, fd, loff_t, off, size_t, len,
| ^~~~~~~~~~~~~~~
include/linux/syscalls.h:1060:17: note: previous declaration of 'sys_cachestat' with type 'long int(unsigned int, long unsigned int, long unsigned int, size_t, struct cachestat *, unsigned int)' {aka 'long int(unsigned int, long unsigned int, long unsigned int, long unsigned int, struct cachestat *, unsigned int)'}
1060 | asmlinkage long sys_cachestat(unsigned int fd, unsigned long off_low,
| ^~~~~~~~~~~~~

vim +243 include/linux/syscalls.h

1bd21c6c21e848 Dominik Brodowski   2018-04-05  232  
e145242ea0df6b Dominik Brodowski   2018-04-09  233  /*
e145242ea0df6b Dominik Brodowski   2018-04-09  234   * The asmlinkage stub is aliased to a function named __se_sys_*() which
e145242ea0df6b Dominik Brodowski   2018-04-09  235   * sign-extends 32-bit ints to longs whenever needed. The actual work is
e145242ea0df6b Dominik Brodowski   2018-04-09  236   * done within __do_sys_*().
e145242ea0df6b Dominik Brodowski   2018-04-09  237   */
1bd21c6c21e848 Dominik Brodowski   2018-04-05  238  #ifndef __SYSCALL_DEFINEx
bed1ffca022cc8 Frederic Weisbecker 2009-03-13  239  #define __SYSCALL_DEFINEx(x, name, ...)					\
bee20031772af3 Arnd Bergmann       2018-06-19  240  	__diag_push();							\
bee20031772af3 Arnd Bergmann       2018-06-19  241  	__diag_ignore(GCC, 8, "-Wattribute-alias",			\
bee20031772af3 Arnd Bergmann       2018-06-19  242  		      "Type aliasing is used to sanitize syscall arguments");\
83460ec8dcac14 Andi Kleen          2013-11-12 @243  	asmlinkage long sys##name(__MAP(x,__SC_DECL,__VA_ARGS__))	\
e145242ea0df6b Dominik Brodowski   2018-04-09  244  		__attribute__((alias(__stringify(__se_sys##name))));	\
c9a211951c7c79 Howard McLauchlan   2018-03-21  245  	ALLOW_ERROR_INJECTION(sys##name, ERRNO);			\
e145242ea0df6b Dominik Brodowski   2018-04-09  246  	static inline long __do_sys##name(__MAP(x,__SC_DECL,__VA_ARGS__));\
e145242ea0df6b Dominik Brodowski   2018-04-09  247  	asmlinkage long __se_sys##name(__MAP(x,__SC_LONG,__VA_ARGS__));	\
e145242ea0df6b Dominik Brodowski   2018-04-09  248  	asmlinkage long __se_sys##name(__MAP(x,__SC_LONG,__VA_ARGS__))	\
1a94bc34768e46 Heiko Carstens      2009-01-14  249  	{								\
e145242ea0df6b Dominik Brodowski   2018-04-09  250  		long ret = __do_sys##name(__MAP(x,__SC_CAST,__VA_ARGS__));\
07fe6e00f6cca6 Al Viro             2013-01-21  251  		__MAP(x,__SC_TEST,__VA_ARGS__);				\
2cf0966683430b Al Viro             2013-01-21  252  		__PROTECT(x, ret,__MAP(x,__SC_ARGS,__VA_ARGS__));	\
2cf0966683430b Al Viro             2013-01-21  253  		return ret;						\
1a94bc34768e46 Heiko Carstens      2009-01-14  254  	}								\
bee20031772af3 Arnd Bergmann       2018-06-19  255  	__diag_pop();							\
e145242ea0df6b Dominik Brodowski   2018-04-09  256  	static inline long __do_sys##name(__MAP(x,__SC_DECL,__VA_ARGS__))
1bd21c6c21e848 Dominik Brodowski   2018-04-05  257  #endif /* __SYSCALL_DEFINEx */
1a94bc34768e46 Heiko Carstens      2009-01-14  258  
Signature · 2 lines
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests
#4 lore raw

Re: [PATCH v9 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/20230204-030455
base:   1440f576022887004f719883acb094e7e0dd4944
patch link:    https://lore.kernel.org/r/20230203190413.2559707-3-nphamcs%40gmail.com
patch subject: [PATCH v9 2/3] cachestat: implement cachestat syscall
config: i386-allnoconfig (https://download.01.org/0day-ci/archive/20230204/[email protected]/config)
compiler: gcc-11 (Debian 11.3.0-8) 11.3.0

reproduce (this is a W=1 build):
# https://github.com/intel-lab-lkp/linux/commit/49a57ed71ac2c005231660c85c3f30c4b47d8b7b
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/20230204-030455 git checkout 49a57ed71ac2c005231660c85c3f30c4b47d8b7b
# save the config file
mkdir build_dir && cp config build_dir/.config
make W=1 O=build_dir ARCH=i386 olddefconfig
make W=1 O=build_dir ARCH=i386 SHELL=/bin/bash

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

All warnings (new ones prefixed by >>):

>> mm/filemap.c:4035:6: warning: no previous prototype for 'ksys_cachestat' [-Wmissing-prototypes]

4035 | long ksys_cachestat(unsigned int fd, loff_t off, size_t len,
| ^~~~~~~~~~~~~~

vim +/ksys_cachestat +4035 mm/filemap.c

4033
4034 #ifdef CONFIG_CACHESTAT_SYSCALL

> 4035	long ksys_cachestat(unsigned int fd, loff_t off, size_t len,

4036 struct cachestat __user *cstat, unsigned int flags)
4037 {
4038 struct fd f = fdget(fd);
4039 struct address_space *mapping;
4040 struct cachestat cs;
4041 pgoff_t first_index = off >> PAGE_SHIFT;
4042 pgoff_t last_index =
4043 len == 0 ? ULONG_MAX : (off + len - 1) >> PAGE_SHIFT;
4044
4045 if (!f.file)
4046 return -EBADF;
4047
4048 if (off < 0 || flags != 0) {
4049 fdput(f);
4050 return -EINVAL;
4051 }
4052
4053 memset(&cs, 0, sizeof(struct cachestat));
4054 mapping = f.file->f_mapping;
4055 filemap_cachestat(mapping, first_index, last_index, &cs);
4056 fdput(f);
4057
4058 if (copy_to_user(cstat, &cs, sizeof(struct cachestat)))
4059 return -EFAULT;
4060
4061 return 0;
4062 }
4063

Signature · 2 lines
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests
#5 lore raw

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

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

Hi Nhat,

Thank you for the patch! Yet something to improve:

[auto build test ERROR on 1440f576022887004f719883acb094e7e0dd4944]

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

reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross chmod +x ~/bin/make.cross
# https://github.com/intel-lab-lkp/linux/commit/49a57ed71ac2c005231660c85c3f30c4b47d8b7b
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/20230204-030455 git checkout 49a57ed71ac2c005231660c85c3f30c4b47d8b7b
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross W=1 O=build_dir ARCH=arm olddefconfig COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross W=1 O=build_dir ARCH=arm SHELL=/bin/bash

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

All errors (new ones prefixed by >>):

mm/filemap.c:4035:6: warning: no previous prototype for 'ksys_cachestat' [-Wmissing-prototypes]
4035 | long ksys_cachestat(unsigned int fd, loff_t off, size_t len,
| ^~~~~~~~~~~~~~
In file included from mm/filemap.c:25:

>> include/linux/syscalls.h:243:25: error: conflicting types for 'sys_cachestat'; have 'long int(unsigned int,  loff_t,  size_t,  struct cachestat *, unsigned int)' {aka 'long int(unsigned int,  long long int,  unsigned int,  struct cachestat *, unsigned int)'}
     243 |         asmlinkage long sys##name(__MAP(x,__SC_DECL,__VA_ARGS__))       \
         |                         ^~~
   include/linux/syscalls.h:229:9: note: in expansion of macro '__SYSCALL_DEFINEx'
     229 |         __SYSCALL_DEFINEx(x, sname, __VA_ARGS__)
         |         ^~~~~~~~~~~~~~~~~
   include/linux/syscalls.h:222:36: note: in expansion of macro 'SYSCALL_DEFINEx'
     222 | #define SYSCALL_DEFINE5(name, ...) SYSCALL_DEFINEx(5, _##name, __VA_ARGS__)
         |                                    ^~~~~~~~~~~~~~~

mm/filemap.c:4095:1: note: in expansion of macro 'SYSCALL_DEFINE5'
4095 | SYSCALL_DEFINE5(cachestat, unsigned int, fd, loff_t, off, size_t, len,
| ^~~~~~~~~~~~~~~
include/linux/syscalls.h:1060:17: note: previous declaration of 'sys_cachestat' with type 'long int(unsigned int, long unsigned int, long unsigned int, size_t, struct cachestat *, unsigned int)' {aka 'long int(unsigned int, long unsigned int, long unsigned int, unsigned int, struct cachestat *, unsigned int)'}
1060 | asmlinkage long sys_cachestat(unsigned int fd, unsigned long off_low,
| ^~~~~~~~~~~~~

vim +243 include/linux/syscalls.h

1bd21c6c21e848 Dominik Brodowski   2018-04-05  232  
e145242ea0df6b Dominik Brodowski   2018-04-09  233  /*
e145242ea0df6b Dominik Brodowski   2018-04-09  234   * The asmlinkage stub is aliased to a function named __se_sys_*() which
e145242ea0df6b Dominik Brodowski   2018-04-09  235   * sign-extends 32-bit ints to longs whenever needed. The actual work is
e145242ea0df6b Dominik Brodowski   2018-04-09  236   * done within __do_sys_*().
e145242ea0df6b Dominik Brodowski   2018-04-09  237   */
1bd21c6c21e848 Dominik Brodowski   2018-04-05  238  #ifndef __SYSCALL_DEFINEx
bed1ffca022cc8 Frederic Weisbecker 2009-03-13  239  #define __SYSCALL_DEFINEx(x, name, ...)					\
bee20031772af3 Arnd Bergmann       2018-06-19  240  	__diag_push();							\
bee20031772af3 Arnd Bergmann       2018-06-19  241  	__diag_ignore(GCC, 8, "-Wattribute-alias",			\
bee20031772af3 Arnd Bergmann       2018-06-19  242  		      "Type aliasing is used to sanitize syscall arguments");\
83460ec8dcac14 Andi Kleen          2013-11-12 @243  	asmlinkage long sys##name(__MAP(x,__SC_DECL,__VA_ARGS__))	\
e145242ea0df6b Dominik Brodowski   2018-04-09  244  		__attribute__((alias(__stringify(__se_sys##name))));	\
c9a211951c7c79 Howard McLauchlan   2018-03-21  245  	ALLOW_ERROR_INJECTION(sys##name, ERRNO);			\
e145242ea0df6b Dominik Brodowski   2018-04-09  246  	static inline long __do_sys##name(__MAP(x,__SC_DECL,__VA_ARGS__));\
e145242ea0df6b Dominik Brodowski   2018-04-09  247  	asmlinkage long __se_sys##name(__MAP(x,__SC_LONG,__VA_ARGS__));	\
e145242ea0df6b Dominik Brodowski   2018-04-09  248  	asmlinkage long __se_sys##name(__MAP(x,__SC_LONG,__VA_ARGS__))	\
1a94bc34768e46 Heiko Carstens      2009-01-14  249  	{								\
e145242ea0df6b Dominik Brodowski   2018-04-09  250  		long ret = __do_sys##name(__MAP(x,__SC_CAST,__VA_ARGS__));\
07fe6e00f6cca6 Al Viro             2013-01-21  251  		__MAP(x,__SC_TEST,__VA_ARGS__);				\
2cf0966683430b Al Viro             2013-01-21  252  		__PROTECT(x, ret,__MAP(x,__SC_ARGS,__VA_ARGS__));	\
2cf0966683430b Al Viro             2013-01-21  253  		return ret;						\
1a94bc34768e46 Heiko Carstens      2009-01-14  254  	}								\
bee20031772af3 Arnd Bergmann       2018-06-19  255  	__diag_pop();							\
e145242ea0df6b Dominik Brodowski   2018-04-09  256  	static inline long __do_sys##name(__MAP(x,__SC_DECL,__VA_ARGS__))
1bd21c6c21e848 Dominik Brodowski   2018-04-05  257  #endif /* __SYSCALL_DEFINEx */
1a94bc34768e46 Heiko Carstens      2009-01-14  258  
Signature · 2 lines
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests
maintainer
#6 lore raw

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

In reply to Nhat Pham
Quoted 12 lines · Nhat Pham
mm/filemap.c +8 -0
+SYSCALL_DEFINE5(cachestat, unsigned int, fd, loff_t, off, size_t, len,
+		struct cachestat __user *, cstat, unsigned int, flags)
+{
+	return ksys_cachestat(fd, off, len, cstat, flags);
+}
+
+#ifdef CONFIG_COMPAT
+COMPAT_SYSCALL_DEFINE6(cachestat, unsigned int, fd, 

compat_arg_u64_dual(off),

mm/filemap.c +3 -0
+		size_t, len, struct cachestat __user *, cstat, unsigned int, flags)
+{
+	return ksys_cachestat(fd, compat_arg_u64_glue(off), len, cstat, 
Quoted 2 lines

flags);
+}

This still looks wrong to me, as this compat definition does not match the native variant on architectures that require 64-bit arguments to be passed in aligned register pairs, such as arm, mips or ppc, but not x86, s390 or riscv.

Arnd

author maintainer
#7 lore raw

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

Quoted 13 lines · Arnd Bergmann
Quoted 10 lines · Nhat Pham
mm/filemap.c +8 -0
+SYSCALL_DEFINE5(cachestat, unsigned int, fd, loff_t, off, size_t, len,
+             struct cachestat __user *, cstat, unsigned int, flags)
+{
+     return ksys_cachestat(fd, off, len, cstat, flags);
+}
+
+#ifdef CONFIG_COMPAT
+COMPAT_SYSCALL_DEFINE6(cachestat, unsigned int, fd,

compat_arg_u64_dual(off),
+ size_t, len, struct cachestat __user *, cstat, unsigned

int, flags)

Quoted 9 lines
Quoted 4 lines
(quoted diff) +2 -0
+{
+     return ksys_cachestat(fd, compat_arg_u64_glue(off), len, cstat,

flags);
+}

This still looks wrong to me, as this compat definition does not match the native variant on architectures that require 64-bit arguments to be passed in aligned register pairs, such as arm, mips or ppc, but not x86, s390 or riscv.

Oh I see - thanks for pointing that out! And the last bit means this is a non-issue for x86, s390 or riscv right?

And iirc from the last thread, this is fixable via a simple reordering of the args in order to properly align the 64-bit arguments, for e.g:

SYSCALL_DEFINE5(cachestat, loff_t, off, unsigned int, fd, size_t, len,
struct cachestat __user *, cstat, unsigned int, flags)

...

COMPAT_SYSCALL_DEFINE6(cachestat, compat_arg_u64_dual(off),
unsigned int, fd, size_t, len, struct cachestat __user *,
cstat,
unsigned int, flags)

It looks a bit odd to me that fd is not the first argument, but perhaps this is an acceptable sacrifice to avoid unused arg and keep the flags...

Let me know what you think about this!

Quoted 3 lines

Arnd

maintainer
#8 lore raw

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

Quoted 23 lines · Nhat Pham
Quoted 13 lines · Arnd Bergmann
Quoted 11 lines · Nhat Pham
mm/filemap.c +8 -0
+SYSCALL_DEFINE5(cachestat, unsigned int, fd, loff_t, off, size_t, len,
+             struct cachestat __user *, cstat, unsigned int, flags)
+{
+     return ksys_cachestat(fd, off, len, cstat, flags);
+}
+
+#ifdef CONFIG_COMPAT
+COMPAT_SYSCALL_DEFINE6(cachestat, unsigned int, fd, 

compat_arg_u64_dual(off),

mm/filemap.c +2 -0
+             size_t, len, struct cachestat __user *, cstat, unsigned int, flags)
+{
Quoted 8 lines
Quoted 3 lines

+ return ksys_cachestat(fd, compat_arg_u64_glue(off), len, cstat,
flags);
+}

This still looks wrong to me, as this compat definition does not match the native variant on architectures that require 64-bit arguments to be passed in aligned register pairs, such as arm, mips or ppc, but not x86, s390 or riscv.

Quoted 2 lines

Oh I see - thanks for pointing that out! And the last bit means this is a non-issue for x86, s390 or riscv right?

Right. It still requires the separate compat entry point that we generally try to avoid for new syscalls, but it's probably still better than passing the offset through a pointer.

Quoted 13 lines

And iirc from the last thread, this is fixable via a simple reordering of the args in order to properly align the 64-bit arguments, for e.g:

SYSCALL_DEFINE5(cachestat, loff_t, off, unsigned int, fd, size_t, len,
struct cachestat __user *, cstat, unsigned int, flags)

...

COMPAT_SYSCALL_DEFINE6(cachestat, compat_arg_u64_dual(off),
unsigned int, fd, size_t, len, struct cachestat __user *, cstat, unsigned int, flags)

Quoted 4 lines

It looks a bit odd to me that fd is not the first argument, but perhaps this is an acceptable sacrifice to avoid unused arg and keep the flags...

Let me know what you think about this!

Right, this should work. You can also move the offset to the third or fifth argument in order to keep the fd one first.

I would actually like to change all the syscalls that have loff_t arguments to have explicit '64-bit' and '32-bit' versions rather than 'native' and 'compat', to make it more obvious what is going on even on the architectures that have no 64-bit variant. That is something to do later though, you should definitely keep doing this the same way we do for all other syscalls.

Arnd

author maintainer
#9 lore raw

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

In reply to Arnd Bergmann
Quoted 14 lines · Arnd Bergmann
Quoted 11 lines · Nhat Pham
mm/filemap.c +8 -0
+SYSCALL_DEFINE5(cachestat, unsigned int, fd, loff_t, off, size_t, len,
+             struct cachestat __user *, cstat, unsigned int, flags)
+{
+     return ksys_cachestat(fd, off, len, cstat, flags);
+}
+
+#ifdef CONFIG_COMPAT
+COMPAT_SYSCALL_DEFINE6(cachestat, unsigned int, fd,

compat_arg_u64_dual(off),

mm/filemap.c +2 -0
+             size_t, len, struct cachestat __user *, cstat, unsigned int, flags)
+{
Quoted 8 lines
Quoted 3 lines

+ return ksys_cachestat(fd, compat_arg_u64_glue(off), len, cstat,
flags);
+}

This still looks wrong to me, as this compat definition does not match the native variant on architectures that require 64-bit arguments to be passed in aligned register pairs, such as arm, mips or ppc, but not x86, s390 or riscv.

(looks like I sent the last email in the wrong format - resending this in plain text to see if the problem persists...)

Oh I see - thanks for pointing that out! And the last bit means this is a non-issue for x86, s390 or riscv right?

And iirc from the last thread, this is fixable via a simple reordering of the args in order to properly align the 64-bit arguments, for e.g:

SYSCALL_DEFINE5(cachestat, loff_t, off, unsigned int, fd, size_t, len,
struct cachestat __user *, cstat, unsigned int, flags)

...

COMPAT_SYSCALL_DEFINE6(cachestat, compat_arg_u64_dual(off),
unsigned int, fd, size_t, len, struct cachestat __user *, cstat, unsigned int, flags)

It looks a bit odd to me that fd is not the first argument, but perhaps this is an acceptable sacrifice to avoid unused arg and keep the flags...

Let me know what you think about this!

Quoted 2 lines

Arnd

author maintainer
#10 lore raw

PATCH v9 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      | 256 ++++++++++++++++++
 5 files changed, 274 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 +256 -0

256 lines not on this page · raw message

Signature · 1 line
2.30.2