From patchwork Thu Dec 8 20:28:07 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nhat Pham X-Patchwork-Id: 13068848 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 26F5FC4167B for ; Thu, 8 Dec 2022 20:28:19 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id C4DC88E0001; Thu, 8 Dec 2022 15:28:17 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id BCDBA8E000A; Thu, 8 Dec 2022 15:28:17 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 9F1CB8E0001; Thu, 8 Dec 2022 15:28:17 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0011.hostedemail.com [216.40.44.11]) by kanga.kvack.org (Postfix) with ESMTP id 7C4C38E0008 for ; Thu, 8 Dec 2022 15:28:17 -0500 (EST) Received: from smtpin24.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay08.hostedemail.com (Postfix) with ESMTP id 52D0F14081C for ; Thu, 8 Dec 2022 20:28:17 +0000 (UTC) X-FDA: 80220276234.24.444EAA9 Received: from mail-pf1-f170.google.com (mail-pf1-f170.google.com [209.85.210.170]) by imf06.hostedemail.com (Postfix) with ESMTP id 95C8D180012 for ; Thu, 8 Dec 2022 20:28:14 +0000 (UTC) Authentication-Results: imf06.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=Sj1r05Ux; spf=pass (imf06.hostedemail.com: domain of nphamcs@gmail.com designates 209.85.210.170 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=1670531294; a=rsa-sha256; cv=none; b=ptGkFaFIou90C3ScnVBapvTh8qiq6Wc7Rjy7LqUCZedAC2fOnZ5i20mddnxmn4dLcbKmkk ecTkZr4z5yZdnAQ7hrs2jG0cdgJfoB2NXp4Ef5BwimfjodBdGaFJvkn69pSeUHbzlXUpsG VDbXFs1h9Iu4Mq21iIMZYUIf8kpWz+c= ARC-Authentication-Results: i=1; imf06.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=Sj1r05Ux; spf=pass (imf06.hostedemail.com: domain of nphamcs@gmail.com designates 209.85.210.170 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=1670531294; 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=6OziiiRLNSzXipRtwNVO5s9HQHhNZWgMZRqqlEYKjCM=; b=bL1Zai7Ij3e8tl+ZcRYzXRz8BZTnzfzxZ07t9GYamgT672CG8bfk1MDPMYaNlkEOKJ7HMY oHgSRKofIFexctz8NkE3EWI7aSRfhWNmjCVqUJKLfT1uTk37aShJQoUQhE6Uw7L+cFdHaz Z4s5HDDNt96h8+6ZW94s+CFOWTLy3XA= Received: by mail-pf1-f170.google.com with SMTP id a14so2199760pfa.1 for ; Thu, 08 Dec 2022 12:28:14 -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=6OziiiRLNSzXipRtwNVO5s9HQHhNZWgMZRqqlEYKjCM=; b=Sj1r05Uxh4eVh/6W58ylqxHpfLInFjmnJeqicXpequk2IVw/m7OUcDMB4x4cS43b1y qHAoTWDfw6IggNsUy+yQjBC9fqr/Te+hZ08h7UIb7sD3LZvROoXD6eL5gRVyfCX41VQX UhZmPwipNnCMFaee1EXQnZTxoKst8Vu/9Ow0NdvRbRZdg8Ven5hXjI5LXOJF1fTCZlWp HNd2tDMp7CQz/fOeAiRUGse/Qs844DdR5yFJuZ0B1u2nyRuCunKWWinN0rUhPNj/Bnh6 5oRYVaObj9XMCT0+cZ/QSh9/3sMpW+o8F5fRTz3TDt7Hq6oWEjY7LEp7iwdFz0NT5LDY IrRg== 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=6OziiiRLNSzXipRtwNVO5s9HQHhNZWgMZRqqlEYKjCM=; b=Asc+U95RofKO7Y493s4berCYu6ymW9f956lSeNM/denvICA9E1L9ESTm0V/yUSzTYk 9QcDRDoji3V6i831SMi6N91oxkdowaxBSQ6l6SW8r5+6J3bK9ubXVxDDnwl1y3b/v53W xWAoU6gatxqUjJXupfvN8CAGZNTBp8lalTB/gnbp/HReLraqrkzZGuHCxsVg77roNznW 1FBSXdhmEtomWREeIOXIZGhe/KvwDocxvCXb0SEtWyAUruebbHNlIK0hcRSYd7c2sJ3a u+n85DPglo8C6E+B0a3Y4uRjOGzHwN49P+RNMiYP231+fOgtwYM7HTcdyMrEmO5Wa6Xw qztg== X-Gm-Message-State: ANoB5pk1Uu1rmzckCssNL7jFV/nbDN2+fzw/cmykVt7ar3lQw6gezMJS GiZnrNejXgGACgXB+ixyx3w= X-Google-Smtp-Source: AA0mqf6ywRIfSzRQ1duTnwiS9H9Br9ok+5JvQ3sujZRbMhXsr5F8exqSPgt9Efffxc1wUpIGL6Dgxg== X-Received: by 2002:a63:1f20:0:b0:478:3376:b7bf with SMTP id f32-20020a631f20000000b004783376b7bfmr42072708pgf.5.1670531293423; Thu, 08 Dec 2022 12:28:13 -0800 (PST) Received: from localhost (fwdproxy-prn-018.fbsv.net. [2a03:2880:ff:12::face:b00c]) by smtp.gmail.com with ESMTPSA id t15-20020a63f34f000000b0046fefb18a09sm13280771pgj.91.2022.12.08.12.28.12 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 08 Dec 2022 12:28:12 -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 v3 3/4] cachestat: implement cachestat syscall Date: Thu, 8 Dec 2022 12:28:07 -0800 Message-Id: <20221208202808.908690-4-nphamcs@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20221208202808.908690-1-nphamcs@gmail.com> References: <20221208202808.908690-1-nphamcs@gmail.com> MIME-Version: 1.0 X-Rspam-User: X-Rspamd-Queue-Id: 95C8D180012 X-Rspamd-Server: rspam01 X-Stat-Signature: 3f95wtmtirwb1uxcs18wq76jjic815hz X-HE-Tag: 1670531294-17255 X-HE-Meta: U2FsdGVkX18ljn7VSX/Z/Vvk/yD5DQG7nKKXhEScx5V1uS9FYlVQutRZgfQD4e+OJXN8A35ZAnPdJoqw9L9LnU/C6KMDi2SZCDWqQxn0rsduvAFVX0aqLoXa1ICHiPE9QC6Vnej2pbCsXd4HmHJDcpQeSy9TZtmV7O3Xws0SW5HTZRH4Ql/gBW6hcWeI0+jP1vW6DJlbU0+mzhgIQo2DndnpgGqiObAq8dpmZHOETVKyyapieGEywkEVpLzq17WY3mxu+XvsXvQ0WtGptabmbk+JWldgCp6Ej+oOwIxyDpoOduW409kZ/ZAawAk6B5xA502q2Q3WZ+WaI4w6+pl71c537wIckxmlsN4c5XyCdq+rIpmZeyCsi6p4Dr3aJ99whzYPRIjFWJ5PkrJbvoXB/RVr+XDK3L6/7w8C885y8eFT/jl8Z48D9dQUOWp/dpiO7e6iS4/QqUL25SFUfZ1H2ZXyYSLwQ6ccQDJa2K4/cDWvUMrXYX7YmX4Ys0cRPrmLPiSyGnksIBS4h6vOhf6cz4PePtSYQXy4jRXJadKNOVGUn7Sl10RQiZG0ISjgoe5aRVNt5GvsmlSYaJ9AVy5OxLu/z3xmSaOHviz88usmZT/Qi1KNcANhwlqQ7QNBsci1KouBWtZoy0y8047h2te7AruVmH5trCBgoR3pXTgjRzMadCGconvj5O2M4pX9Mc/0Z0ueE0qZFCi0MywMheN5EZ8nQWdOWJyayZ2/VkCdDTptrWRuINBhoUNzjuUYINMw0GUy+xerb9HvyyT6ciJdX5/v0TpvdORV/QkMY826xTK5RhuG+g2fI8WqxVl8ArBuCcO53riSNZIz6C813QyPJ2z+hDosJ/lJ+lsi2C5VwaKppTGRhaVXKnhi6v5953jBwFX4uYFOnF3YoXXVpxhUFYekhzLNDVKZryjHH4eOc/011sM+jzW+z0zlYx886gUTxl3HE6rI4awFiZXfeuo ZTOLgP6p BdoEIi0VUde/mMy90VOxsuecBrsoPLSQJ28DAG3WjUaIMZTSsP9npKTXFHEYT+ltnELKlbAfhsK9SlDs8gwyjTY7EpUwbZXeHw55y9AjRbR+zRUqISVwdcWS0a/Stpv4NjHED 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 status 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 (recently) evicted pages, in the bytes range given by `off` and `len`. 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 Acked-by: Geert Uytterhoeven [m68k] --- 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/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/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/Makefile | 1 + mm/cachestat.c | 117 ++++++++++++++++++++ 21 files changed, 165 insertions(+), 1 deletion(-) create mode 100644 mm/cachestat.c -- 2.30.2 diff --git a/MAINTAINERS b/MAINTAINERS index a198da986146..baa081a1fe52 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -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 +M: Johannes Weiner +L: linux-mm@kvack.org +S: Maintained +F: mm/cachestat.c + CADENCE MIPI-CSI2 BRIDGES M: Maxime Ripard L: linux-media@vger.kernel.org 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..8eed4cdc7965 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/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..ecc4f781dd6c 100644 --- a/init/Kconfig +++ b/init/Kconfig @@ -1798,6 +1798,16 @@ config RSEQ If unsure, say Y. +config CACHESTAT + 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/Makefile b/mm/Makefile index 8e105e5b3e29..61c9c3f81cef 100644 --- a/mm/Makefile +++ b/mm/Makefile @@ -138,3 +138,4 @@ obj-$(CONFIG_IO_MAPPING) += io-mapping.o obj-$(CONFIG_HAVE_BOOTMEM_INFO_NODE) += bootmem_info.o obj-$(CONFIG_GENERIC_IOREMAP) += ioremap.o obj-$(CONFIG_SHRINKER_DEBUG) += shrinker_debug.o +obj-$(CONFIG_CACHESTAT) += cachestat.o diff --git a/mm/cachestat.c b/mm/cachestat.c new file mode 100644 index 000000000000..931f5e37326b --- /dev/null +++ b/mm/cachestat.c @@ -0,0 +1,117 @@ +// SPDX-License-Identifier: GPL-2.0-or-later + +/* + * The cachestat() system call. + */ +#include +#include +#include +#include +#include +#include +#include + +#include "swap.h" + +/* + * The cachestat(5) system call. + * + * cachestat() returns the page cache status of a file in the + * bytes specified by `off` and `len`: number of cached pages, + * number of dirty pages, number of pages marked for writeback, + * number of (recently) evicted pages. + * + * `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; + struct cachestat cs; + + memset(&cs, 0, sizeof(struct cachestat)); + + if (off < 0 || cstat_size > sizeof(struct cachestat) || flags != 0) + return -EINVAL; + + if (!access_ok(cstat, sizeof(struct cachestat))) + return -EFAULT; + + f = fdget(fd); + if (f.file) { + struct address_space *mapping = f.file->f_mapping; + pgoff_t first_index = off >> PAGE_SHIFT; + pgoff_t last_index = + len == 0 ? ULONG_MAX : (off + len - 1) >> PAGE_SHIFT; + XA_STATE(xas, &mapping->i_pages, first_index); + struct folio *folio; + + rcu_read_lock(); + xas_for_each(&xas, folio, last_index) { + if (xas_retry(&xas, folio) || !folio) + continue; + + if (xa_is_value(folio)) { + /* page is evicted */ + void *shadow = (void *)folio; + bool workingset; /* not used */ + + cs.nr_evicted += 1; + +#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 += 1; + + continue; + } + + /* page is in cache */ + cs.nr_cache += 1; + + if (folio_test_dirty(folio)) + cs.nr_dirty += 1; + + if (folio_test_writeback(folio)) + cs.nr_writeback += 1; + } + rcu_read_unlock(); + fdput(f); + + if (copy_to_user(cstat, &cs, cstat_size)) + return -EFAULT; + + return 0; + } + + return -EBADF; +}