From patchwork Wed Jan 4 23:10:56 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nhat Pham X-Patchwork-Id: 13089183 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id D61FCC54E76 for ; Wed, 4 Jan 2023 23:11:04 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 633B1900003; Wed, 4 Jan 2023 18:11:04 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 56EC5900002; Wed, 4 Jan 2023 18:11:04 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 21019900003; Wed, 4 Jan 2023 18:11:04 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0016.hostedemail.com [216.40.44.16]) by kanga.kvack.org (Postfix) with ESMTP id 128D6900002 for ; Wed, 4 Jan 2023 18:11:04 -0500 (EST) Received: from smtpin20.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay03.hostedemail.com (Postfix) with ESMTP id CB50BA06B4 for ; Wed, 4 Jan 2023 23:11:03 +0000 (UTC) X-FDA: 80318664006.20.3DC5571 Received: from mail-pj1-f43.google.com (mail-pj1-f43.google.com [209.85.216.43]) by imf13.hostedemail.com (Postfix) with ESMTP id 1C7E420009 for ; Wed, 4 Jan 2023 23:11:01 +0000 (UTC) Authentication-Results: imf13.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=lf3GdCSy; spf=pass (imf13.hostedemail.com: domain of nphamcs@gmail.com designates 209.85.216.43 as permitted sender) smtp.mailfrom=nphamcs@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1672873862; a=rsa-sha256; cv=none; b=TKZrnnOxXpcPneQNLByoELSJWFSmwDIt6TIkG+QKi0BEkvjFu9jdQsRiGz97u54cmgzCwS zI8rYmmgm3DwvKEbwCc2SsPbxmTCbpVMEwWVP7tSspD+GW0duMO1eSxvBZWwsLR3b+y0uv 1ZEVdnpDQ5Xi9MLvEMWPWePhnyLPg5g= ARC-Authentication-Results: i=1; imf13.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=lf3GdCSy; spf=pass (imf13.hostedemail.com: domain of nphamcs@gmail.com designates 209.85.216.43 as permitted sender) smtp.mailfrom=nphamcs@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1672873862; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=hwlxEUnJTi8kdi6xZ46qNfgxCPxAuMa9Au9bZGZF4I4=; b=hO80dPxKrUUFRW5Fto8uAAoGJwNpfxFGUg+r7j7qs5r97tZe6hK1l59RIdhBfTec4bkVf1 hS54JCv3UbWAYGdXPDduzYhFp6ZGK8ubDR4wEPT5lfGbJrPZ1jdF0L0rMcM6zK1M+9jinD goVsjq2qccHQb9k7vAMDI7HLb+tuuzA= Received: by mail-pj1-f43.google.com with SMTP id c8-20020a17090a4d0800b00225c3614161so121371pjg.5 for ; Wed, 04 Jan 2023 15:11:01 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=hwlxEUnJTi8kdi6xZ46qNfgxCPxAuMa9Au9bZGZF4I4=; b=lf3GdCSyBD9dCs6TuI78dkgOsx8bcrQ3TM6YGzYVOaDMheBLOk34q967cdJOeX4t7i ACQyHDDCzv6Fp9TN6KWinnjGVgZ4cZj0bg8rtsEND3Or1vpiZaoVXgTi5fA/CoAH7n0L VfyG+zsrWyenteHljLfny1WmdiijaJnmXUBoTq3RjSciXg55dRsiLkfms1F5j4rMOh3k x9R2ibR7cUj7OftcMgwCIlvt/cQdJQdEFXWTyZvE2wcULZDAn+xci9rQFz8ujjF7iAoF 6jh5GL9Ud2Ox7DalK+bQlzndK01X2aN7I8RRTnrJ8NPDoxieqdBoTIlSuZZDMe6l+4b6 PvJA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=hwlxEUnJTi8kdi6xZ46qNfgxCPxAuMa9Au9bZGZF4I4=; b=yN0iT5dwntXSPqvCtAPdbOTOmy0x/Bx/ztYGxcc0QKOgJU/k9ianlZyR2WymFja6l8 oP6Wkf+qVAu+t1TuldoREgdOv/nDSPKktxci93OCL+hc2Nmu4OSa4EBHq+96Yc2Cd1ko t9lpDk1Cl7RR3kGN3wZhOp33d/KAwVix/5Nd9ob3qbuVGTVxg2lQ7dXSeFGX8lTJ96ZC qycNgpo1Mh2WnnClVZZ5AGmzXE5HNhnNZKdozGmZEExxRK3tflSzeGQuBbCQov6mJ1rA qfsWKhQ0+F8+F8HGTkougggjUxvdsrHerY/Bt97Z1bJ60uKGcBwDfY/ciP3uH7hYJwTE Br8A== X-Gm-Message-State: AFqh2koauHcBm6GmsPZYejidLMRO8nMBdz+xqyr+yZkPAwzMM+P8dSI+ 1w6tv9BPz6PEwrpeXgeZV+Y= X-Google-Smtp-Source: AMrXdXv/qnwOg7LmZf7k1BK0zyUzuLhSjPgTUSdVMyQ9CZeiKyznISRUg0wEPvwAPT7bEsplPPZgNA== X-Received: by 2002:a17:902:728d:b0:191:3993:801e with SMTP id d13-20020a170902728d00b001913993801emr44991135pll.56.1672873860878; Wed, 04 Jan 2023 15:11:00 -0800 (PST) Received: from localhost (fwdproxy-prn-119.fbsv.net. [2a03:2880:ff:77::face:b00c]) by smtp.gmail.com with ESMTPSA id m12-20020a1709026bcc00b00188c9c11559sm24735698plt.1.2023.01.04.15.11.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 04 Jan 2023 15:11:00 -0800 (PST) From: Nhat Pham To: akpm@linux-foundation.org Cc: hannes@cmpxchg.org, linux-mm@kvack.org, linux-kernel@vger.kernel.org, bfoster@redhat.com, willy@infradead.org, kernel-team@meta.com Subject: [PATCH v5 2/3] cachestat: implement cachestat syscall Date: Wed, 4 Jan 2023 15:10:56 -0800 Message-Id: <20230104231057.2632639-3-nphamcs@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230104231057.2632639-1-nphamcs@gmail.com> References: <20230104231057.2632639-1-nphamcs@gmail.com> MIME-Version: 1.0 X-Rspam-User: X-Rspamd-Server: rspam03 X-Rspamd-Queue-Id: 1C7E420009 X-Stat-Signature: wc83xfakd1gjgaboikgoaonygn59u7ei X-HE-Tag: 1672873861-808262 X-HE-Meta: U2FsdGVkX19XUrnOYtEx5ojYRsh89UL/lqDBbwrkO6AQOPAI0sFmc+q60TOXPAM4uPt/5CSlX3CZWFoLgDCcs0U2nYqZ9eTAvyc6IkK09fqA+WlMHN9XNumjvDs38cM3F6t9dNxRaFPI37qH/QqVB5te2ni0rQwlEkxraLYz/UKNhOZ0ERQg57Yk2TDnai7Cy+tkoT7lMwQUwLrByS5gKzD7D8lL7M8uVn/j3F1at/Z+KqFzYbg+DG8jDa+sBTKbgG3nuYGR4x307HKnNGWU4CsSddwNvREmRVvl2CDUVHPlj4+UvNoFEe+gOVYPYdbKEtRvUe4sAUZfadGQXY8f23Lf5f40pGN2h0WMDY8twqHsSFNy4ZGWAa20XZFfuPfAOgeBJBzN0TmTZ3Ie+/+4tARBCvyYD2rHY6D5mkDO3mu07HvsAEBQUbcFuOfNMFqxLf8IiQnlJj/MuPJ57VkXJ2qPN0bg9E8bwQQL6rpnm1d8i/9XWzfWxYxnEJV+Z11atrM2wDxNy0zwwvOHwP2kYAdpTOyHi3jnblgG2Dq9TtUUYkIraxuBKUfNCozMvThBHMmhddIJ3Z0Ti+lg1DEVomRfYWKy1aJIle85AaT4ok/elI6JdkojSotXpAaXsohYz53GKLAvTX3O/zwgmZfIA/5eH5j2fS3ez19dfG3SSb1vkzIWJrn7yKwgRMe1z+CztdjLYfuKqxDVES2PLUhLs6OsZC+MbpDOO9njTHdvuIEGeZMP9v6xCPmPdkuKYCH/lMCTM2ZDHMkpyQmLm6JlcIoQvqMyGbWZ+TIom1L6luY+QRGbzrKABfi1ajvObx4PTFhCjY3FdC9xV3RaFkmBP2LVMdBuaDd9EuREiuvDEOVT03EglXtamTR2Vb046PByaNtCGUAGYj2bTawR5AG9C0UVwDhVhRn8GQERIRqTKGZKCSiEEA+EVVKBMVT5+XCigkri1s09/RzfTY8YCHh DHg1JQkh InIE0bCy2AsiRpgoQ7QjlgMARq0ZWg9Bf8Cbr9cy+HF0jAohLNmKgtIVqMPc4pONZrsuB1pJMTvpNb8Q5m5e5CsSpQXvJejJ+FubNgowX/4Tu6YdvYLk/cyOk5mGcBkBfz+zX X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: Implement 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 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, size_t cstat_size, 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_size` allows users to obtain partial results. The syscall will copy the first `csstat_size` bytes to the specified userspace memory. `cstat_size` must be a non-negative value that is no larger than the current size of the cachestat struct. 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_size` or `flags` EBADF invalid file descriptor. Signed-off-by: Nhat Pham --- 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/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 | 3 + include/uapi/asm-generic/unistd.h | 5 +- include/uapi/linux/mman.h | 9 ++ init/Kconfig | 10 ++ kernel/sys_ni.c | 1 + mm/filemap.c | 143 ++++++++++++++++++++ 20 files changed, 186 insertions(+), 1 deletion(-) diff --git a/arch/alpha/kernel/syscalls/syscall.tbl b/arch/alpha/kernel/syscalls/syscall.tbl index 8ebacf37a8cf..1f13995d00d7 100644 --- a/arch/alpha/kernel/syscalls/syscall.tbl +++ b/arch/alpha/kernel/syscalls/syscall.tbl @@ -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 diff --git a/arch/arm/tools/syscall.tbl b/arch/arm/tools/syscall.tbl index ac964612d8b0..8ebed8a13874 100644 --- a/arch/arm/tools/syscall.tbl +++ b/arch/arm/tools/syscall.tbl @@ -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 diff --git a/arch/ia64/kernel/syscalls/syscall.tbl b/arch/ia64/kernel/syscalls/syscall.tbl index 72c929d9902b..f8c74ffeeefb 100644 --- a/arch/ia64/kernel/syscalls/syscall.tbl +++ b/arch/ia64/kernel/syscalls/syscall.tbl @@ -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 diff --git a/arch/m68k/kernel/syscalls/syscall.tbl b/arch/m68k/kernel/syscalls/syscall.tbl index b1f3940bc298..4f504783371f 100644 --- a/arch/m68k/kernel/syscalls/syscall.tbl +++ b/arch/m68k/kernel/syscalls/syscall.tbl @@ -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 diff --git a/arch/microblaze/kernel/syscalls/syscall.tbl b/arch/microblaze/kernel/syscalls/syscall.tbl index 820145e47350..858d22bf275c 100644 --- a/arch/microblaze/kernel/syscalls/syscall.tbl +++ b/arch/microblaze/kernel/syscalls/syscall.tbl @@ -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 diff --git a/arch/parisc/kernel/syscalls/syscall.tbl b/arch/parisc/kernel/syscalls/syscall.tbl index 8a99c998da9b..7c84a72306d1 100644 --- a/arch/parisc/kernel/syscalls/syscall.tbl +++ b/arch/parisc/kernel/syscalls/syscall.tbl @@ -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 diff --git a/arch/powerpc/kernel/syscalls/syscall.tbl b/arch/powerpc/kernel/syscalls/syscall.tbl index 2bca64f96164..937460f0a8ec 100644 --- a/arch/powerpc/kernel/syscalls/syscall.tbl +++ b/arch/powerpc/kernel/syscalls/syscall.tbl @@ -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 diff --git a/arch/s390/kernel/syscalls/syscall.tbl b/arch/s390/kernel/syscalls/syscall.tbl index 799147658dee..7df0329d46cb 100644 --- a/arch/s390/kernel/syscalls/syscall.tbl +++ b/arch/s390/kernel/syscalls/syscall.tbl @@ -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 diff --git a/arch/sh/kernel/syscalls/syscall.tbl b/arch/sh/kernel/syscalls/syscall.tbl index 2de85c977f54..97377e8c5025 100644 --- a/arch/sh/kernel/syscalls/syscall.tbl +++ b/arch/sh/kernel/syscalls/syscall.tbl @@ -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 diff --git a/arch/sparc/kernel/syscalls/syscall.tbl b/arch/sparc/kernel/syscalls/syscall.tbl index 4398cc6fb68d..faa835f3c54a 100644 --- a/arch/sparc/kernel/syscalls/syscall.tbl +++ b/arch/sparc/kernel/syscalls/syscall.tbl @@ -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 diff --git a/arch/x86/entry/syscalls/syscall_32.tbl b/arch/x86/entry/syscalls/syscall_32.tbl index 320480a8db4f..bc0a3c941b35 100644 --- a/arch/x86/entry/syscalls/syscall_32.tbl +++ b/arch/x86/entry/syscalls/syscall_32.tbl @@ -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 diff --git a/arch/x86/entry/syscalls/syscall_64.tbl b/arch/x86/entry/syscalls/syscall_64.tbl index c84d12608cd2..227538b0ce80 100644 --- a/arch/x86/entry/syscalls/syscall_64.tbl +++ b/arch/x86/entry/syscalls/syscall_64.tbl @@ -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 diff --git a/arch/xtensa/kernel/syscalls/syscall.tbl b/arch/xtensa/kernel/syscalls/syscall.tbl index 52c94ab5c205..2b69c3c035b6 100644 --- a/arch/xtensa/kernel/syscalls/syscall.tbl +++ b/arch/xtensa/kernel/syscalls/syscall.tbl @@ -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 diff --git a/include/linux/fs.h b/include/linux/fs.h index e654435f1651..83300f1491e7 100644 --- a/include/linux/fs.h +++ b/include/linux/fs.h @@ -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); /* diff --git a/include/linux/syscalls.h b/include/linux/syscalls.h index a34b0f9a9972..50f8c6999d99 100644 --- a/include/linux/syscalls.h +++ b/include/linux/syscalls.h @@ -72,6 +72,7 @@ struct open_how; struct mount_attr; struct landlock_ruleset_attr; enum landlock_rule_type; +struct cachestat; #include #include @@ -1056,6 +1057,8 @@ 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, + size_t cstat_size, struct cachestat __user *cstat, unsigned int flags); /* * Architecture-specific system calls diff --git a/include/uapi/asm-generic/unistd.h b/include/uapi/asm-generic/unistd.h index 45fa180cc56a..cd639fae9086 100644 --- a/include/uapi/asm-generic/unistd.h +++ b/include/uapi/asm-generic/unistd.h @@ -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 diff --git a/include/uapi/linux/mman.h b/include/uapi/linux/mman.h index f55bc680b5b0..fe03ed0b7587 100644 --- a/include/uapi/linux/mman.h +++ b/include/uapi/linux/mman.h @@ -4,6 +4,7 @@ #include #include +#include #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 */ diff --git a/init/Kconfig b/init/Kconfig index 694f7c160c9c..da96ac29af1d 100644 --- a/init/Kconfig +++ b/init/Kconfig @@ -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 diff --git a/kernel/sys_ni.c b/kernel/sys_ni.c index 860b2dcf3ac4..04bfb1e4d377 100644 --- a/kernel/sys_ni.c +++ b/kernel/sys_ni.c @@ -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); diff --git a/mm/filemap.c b/mm/filemap.c index 08341616ae7a..d70d47b20700 100644 --- a/mm/filemap.c +++ b/mm/filemap.c @@ -22,6 +22,7 @@ #include #include #include +#include #include #include #include @@ -55,6 +56,9 @@ #include /* for try_to_free_buffers */ #include +#include + +#include "swap.h" /* * Shared mappings implemented 30.11.1994. It's not fully working yet, @@ -3949,3 +3953,142 @@ bool filemap_release_folio(struct folio *folio, gfp_t gfp) return try_to_free_buffers(folio); } EXPORT_SYMBOL(filemap_release_folio); + +/** + * filemap_cachestat() - compute the page cache statistics of a mapping + * @mapping: The mapping to compute the statistics for. + * @first_index: The starting page cache index. + * @last_index: The final page index (inclusive). + * @cs: the cachestat struct to write the result to. + * + * This will query the page cache statistics of a mapping in the + * page range of [first_index, last_index] (inclusive). The statistics + * queried include: number of dirty pages, number of pages marked for + * writeback, and the number of (recently) evicted pages. + */ +void filemap_cachestat(struct address_space *mapping, pgoff_t first_index, + pgoff_t last_index, struct cachestat *cs) +{ + XA_STATE(xas, &mapping->i_pages, first_index); + struct folio *folio; + + rcu_read_lock(); + xas_for_each(&xas, folio, last_index) { + unsigned long nr_pages; + pgoff_t folio_first_index, folio_last_index; + + if (xas_retry(&xas, folio)) + continue; + + nr_pages = folio_nr_pages(folio); + folio_first_index = folio_pgoff(folio); + folio_last_index = folio_first_index + nr_pages - 1; + + /* Folios might straddle the range boundaries, only count covered subpages */ + if (folio_first_index < first_index) + nr_pages -= first_index - folio_first_index; + + if (folio_last_index > last_index) + nr_pages -= folio_last_index - last_index; + + if (xa_is_value(folio)) { + /* page is evicted */ + void *shadow = (void *)folio; + bool workingset; /* not used */ + + cs->nr_evicted += nr_pages; + +#ifdef CONFIG_SWAP /* implies CONFIG_MMU */ + if (shmem_mapping(mapping)) { + /* shmem file - in swap cache */ + swp_entry_t swp = radix_to_swp_entry(folio); + + shadow = get_shadow_from_swap_cache(swp); + } +#endif + if (workingset_test_recent(shadow, true, &workingset)) + cs->nr_recently_evicted += nr_pages; + + continue; + } + + /* page is in cache */ + cs->nr_cache += nr_pages; + + if (folio_test_dirty(folio)) + cs->nr_dirty += nr_pages; + + if (folio_test_writeback(folio)) + cs->nr_writeback += nr_pages; + } + rcu_read_unlock(); +} +EXPORT_SYMBOL(filemap_cachestat); + +#ifdef CONFIG_CACHESTAT_SYSCALL +/* + * The cachestat(5) system call. + * + * cachestat() returns the page cache statistics of a file in the + * bytes range specified by `off` and `len`: number of cached pages, + * number of dirty pages, number of pages marked for writeback, + * number of evicted pages, and number of recently evicted pages. + * + * 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. + * + * `off` and `len` 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_size` allows users to obtain partial results. The syscall + * will copy the first `csstat_size` bytes to the specified userspace + * memory. It also makes the cachestat struct extensible - new fields + * can be added in the future without breaking existing usage. + * `cstat_size` must be a non-negative value that is no larger than + * the current size of the cachestat struct. + * + * The `flags` argument is unused for now, but is included for future + * extensibility. User should pass 0 (i.e no flag specified). + * + * Because the status of a page can change after cachestat() checks it + * but before it returns to the application, the returned values may + * contain stale information. + * + * return values: + * zero - success + * -EFAULT - cstat points to an illegal address + * -EINVAL - invalid arguments + * -EBADF - invalid file descriptor + */ +SYSCALL_DEFINE6(cachestat, unsigned int, fd, off_t, off, size_t, len, + size_t, cstat_size, struct cachestat __user *, cstat, + unsigned int, flags) +{ + struct fd f = fdget(fd); + struct address_space *mapping; + struct cachestat cs; + pgoff_t first_index = off >> PAGE_SHIFT; + pgoff_t last_index = + len == 0 ? ULONG_MAX : (off + len - 1) >> PAGE_SHIFT; + + if (off < 0 || cstat_size > sizeof(struct cachestat) || flags != 0) + return -EINVAL; + + if (!f.file) + return -EBADF; + + memset(&cs, 0, sizeof(struct cachestat)); + mapping = f.file->f_mapping; + filemap_cachestat(mapping, first_index, last_index, &cs); + fdput(f); + + if (copy_to_user(cstat, &cs, cstat_size)) + return -EFAULT; + + return 0; +} +#endif /* CONFIG_CACHESTAT_SYSCALL */