From patchwork Tue Jan 17 19:59:57 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nhat Pham X-Patchwork-Id: 13105017 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 EFCB6C3DA78 for ; Tue, 17 Jan 2023 20:00:15 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 85BE06B0073; Tue, 17 Jan 2023 15:00:15 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 80B2F6B0074; Tue, 17 Jan 2023 15:00:15 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 6AD056B0075; Tue, 17 Jan 2023 15:00:15 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0014.hostedemail.com [216.40.44.14]) by kanga.kvack.org (Postfix) with ESMTP id 59D566B0073 for ; Tue, 17 Jan 2023 15:00:15 -0500 (EST) Received: from smtpin25.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay08.hostedemail.com (Postfix) with ESMTP id 2A7F014023C for ; Tue, 17 Jan 2023 20:00:15 +0000 (UTC) X-FDA: 80365357590.25.0CFAB90 Received: from mail-pj1-f44.google.com (mail-pj1-f44.google.com [209.85.216.44]) by imf16.hostedemail.com (Postfix) with ESMTP id 55200180010 for ; Tue, 17 Jan 2023 20:00:13 +0000 (UTC) Authentication-Results: imf16.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=KzYiQSMT; spf=pass (imf16.hostedemail.com: domain of nphamcs@gmail.com designates 209.85.216.44 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=1673985613; 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=YRguhEw3CY77NjO4ltDj62CfZtUxun2rreMj0XQVN6o=; b=1rtklvkPrCcJMB4HbTLH+CTMxTM9mavnALzKKZKS5/pu8GBM9dg0CxQtppgbKjGwdjg8Dx WIOy101lh2QxDlni/ubXWRmMIl17/gtBQH0NmsHFLtzhnDRd66qE3mUJkoGZ/XtMy9Q6Bc O9wSIwIcDiOaH+IbkoONMrLPXeUp3JY= ARC-Authentication-Results: i=1; imf16.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=KzYiQSMT; spf=pass (imf16.hostedemail.com: domain of nphamcs@gmail.com designates 209.85.216.44 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=1673985613; a=rsa-sha256; cv=none; b=18q+BfPMoDsnObLCfnxzJ324b09WNit9bG5QSl8CmYkNagxA9yR2sBz1rDBaGDd2Jl3jk/ tdVsXDYdCkz+zTMstfx4WsVNaBQCl3U8mfqmOurz/VmnpuYny9rNrRpq0z/iRKqG/ABUvF /dfiThRGg4zahW/M4MKe3V2Gt2WTisg= Received: by mail-pj1-f44.google.com with SMTP id q64so33516538pjq.4 for ; Tue, 17 Jan 2023 12:00:12 -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=YRguhEw3CY77NjO4ltDj62CfZtUxun2rreMj0XQVN6o=; b=KzYiQSMTAKyHXNw/WCFwcPITqMFvnZG/cOSbCHgWdZkCPLFpZu+3lLrBOny0CUX9YX 6E4VMIUPg5bJQCZy6jid8Njwr3mMUw7zJOPH8NHbf15Pc9hKSgVsY+rh2tIMLBCQjA4p RCfOUA54sAjtFOTk0auPkj7vERAY4lSxn8qfDVvK/NVytSXYa4dq8ph4HT0eIB61O/Ho PglANgzCJKu985Me1Vf9J7pToUtQ/wt6HyosQQudO0zlAY4gCNJChzrrjTp3K1rbPZ3g IUZsq2gBHWG1NDTnDev4zunqNcU0zoL0weMq+cY2AxHyrWGYy5tsijqAWcpQzwjPPCjT z6Jw== 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=YRguhEw3CY77NjO4ltDj62CfZtUxun2rreMj0XQVN6o=; b=PuMhsjsAb+VAEl66N8w0nO7eP5rkjKold57gmNmfi2B/ywbbzJ7gMZDspDzwY9SgwM lR7+OjyWCBwKWIQkASpRwIJ1/yanVL0c+DQ8/eqK4uT0Aw4FY96dYDo91Rgq16xTJoC1 We/XMp4JbDuJ9fRVJ0MFuRkRyKo9AiR4mSElzyNz9XAn5JFXhZnuEZdXMaj0CfgZUXVH Ufc1/5pNK5K+O6F064BlZf0lxpUjRttBjiuboUXq33l1lxO4PrWCqSCR1KmQGB0TvY/z ldKUx7OlN2wRKSS+st6Fxb2tnCDrXWqyqVyAqYHrU1RPUVBHp1KjshWrZ06eFJlczjg2 OfTw== X-Gm-Message-State: AFqh2kq2zNPlUOr6Uc4wRx8cpDYBOk/HZRup8gMxbsGChgsV/zZdIiwg rvQzRbMiuw8gvkCdp8chX10= X-Google-Smtp-Source: AMrXdXtIt9YB1XnCzS+dTfzT9gh3KjT7wZXOO8uJT5f8nQp8Rict742HP3JpsDNbdyPRX0PaTdQ5bw== X-Received: by 2002:a17:903:2154:b0:194:a371:716a with SMTP id s20-20020a170903215400b00194a371716amr4184867ple.60.1673985611955; Tue, 17 Jan 2023 12:00:11 -0800 (PST) Received: from localhost ([2a03:2880:ff:1::face:b00c]) by smtp.gmail.com with ESMTPSA id y21-20020a170902e19500b00176dc67df44sm43037pla.132.2023.01.17.12.00.11 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 17 Jan 2023 12:00:11 -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, linux-api@vger.kernel.org, kernel-team@meta.com Subject: [PATCH v6 1/3] workingset: refactor LRU refault to expose refault recency check Date: Tue, 17 Jan 2023 11:59:57 -0800 Message-Id: <20230117195959.29768-2-nphamcs@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230117195959.29768-1-nphamcs@gmail.com> References: <20230117195959.29768-1-nphamcs@gmail.com> MIME-Version: 1.0 X-Rspamd-Queue-Id: 55200180010 X-Stat-Signature: i3x7k54511cm1sstg148jhzs347645qy X-Rspam-User: X-Rspamd-Server: rspam08 X-HE-Tag: 1673985613-648602 X-HE-Meta: U2FsdGVkX1/glWe4Pgavw4PA1qNKu/Sp0zY2hkU18qo19bSvulw2TDyeY782wcrEVoDXAnbuhHU8o4yrc7G+ikj01rES8EqElNgXnmfop+gkRXedwF8VFYjdMkX7OK2CxMgrYtZZF6w7eadG0qiq1wKX3TpGUXr7b3wbDkaar2zwNrRs4O0HvMsBcjjOrCknpV5ByCWEOkO1g9PUP/Mx1pjpjxmpe/uKJgVMyFNN4dvr6F5M1nZHdxeiNk/UMXG8iEemWUEXdMNsbnbBm5WnE+63GonQxxGLept/VLsfrSv4YP5w0Q7HL/No7TZFKPLVfwXcP7oP9e8DcPXbmQOH9wygVDkU7oYDpeWOiwSF/3U0atnsE/MqedRLlCdZ5ofguNuBRBXW7uQ2N83FQpQeahg7kW5wUev5sRnlMNwttPHMfmOK+pqf3OLvn2p1kQS0VpAH1MqGSI0A/2IJTUq3iVUyqDVxHu/o5v/3DoPymA237xodepuJWB7seQWwL9UbgeJFSUKP1vZlSTtSNgyUzLsE021fqhOHxRevQgdztnNxRYKjUo9v/Qx/PVVMP4FuocrekQQvVZp+veOT5WIwjQpdQzcVqJ9CRdnmCBMb3h7uYECASdnk+4ZOvmO2fsH1yNxt+jWdMLtMP5gHfyUHVoPD//p9v1jNQWjhrGXhZX/h35hLhVsIjAglgOb3aLDpOUnYMuxeC7SiU2/ML8mnB2CXxD4UXLBg6fR31ItOTMqyNTUi7hhua59VkmD+iKotNBI3YgqGBS7XaTCn0BqxX1tCX3djG5fZXet7HV7qOxw4kiRh88cV2ywaeYFqkgLjpgyht37wBTqWvFkZfzPmR9AbKUMMnfPcxVjxwXnDiA8dBXxeQ+an9/3waigoLmgbKGZngDlQ24urQgzOOb9Zdxf8XZaEflcH62eLmKMzmOmvvA0+0WCEn5+Up3IZZGPLWEVN+mEIcBZ/cJmcPJf 6ru7xccx ikOMHNiKwaOQY6aB7lpUCOL7G7dV7WLp2iDb+DbI1X7NhKSQN5HCrR607zBF9LDFBGM4leeORI8Guh/9B0SCOxnlr5GmEk0SnuQj3T2Acn1tG2JgeNlXJZ+UnzNyPJtFfArOb X-Bogosity: Ham, tests=bogofilter, spamicity=0.000002, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: 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. Signed-off-by: Nhat Pham --- include/linux/swap.h | 1 + mm/workingset.c | 129 ++++++++++++++++++++++++++++++------------- 2 files changed, 92 insertions(+), 38 deletions(-) diff --git a/include/linux/swap.h b/include/linux/swap.h index a18cf4b7c724..dae6f6f955eb 100644 --- a/include/linux/swap.h +++ b/include/linux/swap.h @@ -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); diff --git a/mm/workingset.c b/mm/workingset.c index 79585d55c45d..006482c4e0bd 100644 --- a/mm/workingset.c +++ b/mm/workingset.c @@ -244,6 +244,33 @@ static void *lru_gen_eviction(struct folio *folio) return pack_shadow(mem_cgroup_id(memcg), pgdat, token, refs); } +/* + * Test if the folio is recently evicted. + * + * As a side effect, also populates the references with + * values unpacked from the shadow of the evicted folio. + */ +static bool lru_gen_test_recent(void *shadow, bool file, bool *workingset) +{ + struct mem_cgroup *eviction_memcg; + struct lruvec *lruvec; + struct lru_gen_struct *lrugen; + unsigned long min_seq; + + int memcgid; + struct pglist_data *pgdat; + unsigned long token; + + unpack_shadow(shadow, &memcgid, &pgdat, &token, workingset); + eviction_memcg = mem_cgroup_from_id(memcgid); + + lruvec = mem_cgroup_lruvec(eviction_memcg, pgdat); + lrugen = &lruvec->lrugen; + + min_seq = READ_ONCE(lrugen->min_seq[file]); + return !((token >> LRU_REFS_WIDTH) != (min_seq & (EVICTION_MASK >> LRU_REFS_WIDTH))); +} + static void lru_gen_refault(struct folio *folio, void *shadow) { int hist, tier, refs; @@ -306,6 +333,11 @@ static void *lru_gen_eviction(struct folio *folio) return NULL; } +static bool lru_gen_test_recent(void *shadow, bool file, bool *workingset) +{ + return true; +} + static void lru_gen_refault(struct folio *folio, void *shadow) { } @@ -373,40 +405,31 @@ void *workingset_eviction(struct folio *folio, struct mem_cgroup *target_memcg) folio_test_workingset(folio)); } -/** - * workingset_refault - Evaluate the refault of a previously evicted folio. - * @folio: The freshly allocated replacement folio. - * @shadow: Shadow entry of the evicted folio. +/* + * Test if the folio is recently evicted by checking if + * refault distance of shadow exceeds workingset size. * - * Calculates and evaluates the refault distance of the previously - * evicted folio in the context of the node and the memcg whose memory - * pressure caused the eviction. + * As a side effect, populate workingset with the value + * unpacked from shadow. */ -void workingset_refault(struct folio *folio, void *shadow) +bool workingset_test_recent(void *shadow, bool file, bool *workingset) { - bool file = folio_is_file_lru(folio); struct mem_cgroup *eviction_memcg; struct lruvec *eviction_lruvec; unsigned long refault_distance; unsigned long workingset_size; - struct pglist_data *pgdat; - struct mem_cgroup *memcg; - unsigned long eviction; - struct lruvec *lruvec; unsigned long refault; - bool workingset; + int memcgid; - long nr; + struct pglist_data *pgdat; + unsigned long eviction; - if (lru_gen_enabled()) { - lru_gen_refault(folio, shadow); - return; - } + if (lru_gen_enabled()) + return lru_gen_test_recent(shadow, file, workingset); - unpack_shadow(shadow, &memcgid, &pgdat, &eviction, &workingset); + unpack_shadow(shadow, &memcgid, &pgdat, &eviction, workingset); eviction <<= bucket_order; - rcu_read_lock(); /* * Look up the memcg associated with the stored ID. It might * have been deleted since the folio's eviction. @@ -425,7 +448,8 @@ void workingset_refault(struct folio *folio, void *shadow) */ eviction_memcg = mem_cgroup_from_id(memcgid); if (!mem_cgroup_disabled() && !eviction_memcg) - goto out; + return false; + eviction_lruvec = mem_cgroup_lruvec(eviction_memcg, pgdat); refault = atomic_long_read(&eviction_lruvec->nonresident_age); @@ -447,21 +471,6 @@ void workingset_refault(struct folio *folio, void *shadow) */ refault_distance = (refault - eviction) & EVICTION_MASK; - /* - * The activation decision for this folio is made at the level - * where the eviction occurred, as that is where the LRU order - * during folio reclaim is being determined. - * - * However, the cgroup that will own the folio is the one that - * is actually experiencing the refault event. - */ - nr = folio_nr_pages(folio); - memcg = folio_memcg(folio); - pgdat = folio_pgdat(folio); - lruvec = mem_cgroup_lruvec(memcg, pgdat); - - mod_lruvec_state(lruvec, WORKINGSET_REFAULT_BASE + file, nr); - mem_cgroup_flush_stats_delayed(); /* * Compare the distance to the existing workingset size. We @@ -483,8 +492,51 @@ void workingset_refault(struct folio *folio, void *shadow) NR_INACTIVE_ANON); } } - if (refault_distance > workingset_size) + + return refault_distance <= workingset_size; +} + +/** + * workingset_refault - Evaluate the refault of a previously evicted folio. + * @folio: The freshly allocated replacement folio. + * @shadow: Shadow entry of the evicted folio. + * + * Calculates and evaluates the refault distance of the previously + * evicted folio in the context of the node and the memcg whose memory + * pressure caused the eviction. + */ +void workingset_refault(struct folio *folio, void *shadow) +{ + bool file = folio_is_file_lru(folio); + struct pglist_data *pgdat; + struct mem_cgroup *memcg; + struct lruvec *lruvec; + bool workingset; + long nr; + + if (lru_gen_enabled()) { + lru_gen_refault(folio, shadow); + return; + } + + rcu_read_lock(); + + nr = folio_nr_pages(folio); + memcg = folio_memcg(folio); + pgdat = folio_pgdat(folio); + lruvec = mem_cgroup_lruvec(memcg, pgdat); + + if (!workingset_test_recent(shadow, file, &workingset)) { + /* + * The activation decision for this folio is made at the level + * where the eviction occurred, as that is where the LRU order + * during folio reclaim is being determined. + * + * However, the cgroup that will own the folio is the one that + * is actually experiencing the refault event. + */ goto out; + } folio_set_active(folio); workingset_age_nonresident(lruvec, nr); @@ -498,6 +550,7 @@ void workingset_refault(struct folio *folio, void *shadow) mod_lruvec_state(lruvec, WORKINGSET_RESTORE_BASE + file, nr); } out: + mod_lruvec_state(lruvec, WORKINGSET_REFAULT_BASE + file, nr); rcu_read_unlock(); } From patchwork Tue Jan 17 19:59:58 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nhat Pham X-Patchwork-Id: 13105018 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 1CFCDC67871 for ; Tue, 17 Jan 2023 20:00:17 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id A582C6B0074; Tue, 17 Jan 2023 15:00:16 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 9BA076B0075; Tue, 17 Jan 2023 15:00:16 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 770156B0078; Tue, 17 Jan 2023 15:00:16 -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 64CFA6B0074 for ; Tue, 17 Jan 2023 15:00:16 -0500 (EST) Received: from smtpin10.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay04.hostedemail.com (Postfix) with ESMTP id 36FFD1A0BBC for ; Tue, 17 Jan 2023 20:00:16 +0000 (UTC) X-FDA: 80365357632.10.6F80642 Received: from mail-pl1-f172.google.com (mail-pl1-f172.google.com [209.85.214.172]) by imf21.hostedemail.com (Postfix) with ESMTP id 738391C000D for ; Tue, 17 Jan 2023 20:00:14 +0000 (UTC) Authentication-Results: imf21.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=GfD6yi9M; spf=pass (imf21.hostedemail.com: domain of nphamcs@gmail.com designates 209.85.214.172 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=1673985614; 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=lyKvDLCJcKSgVtBGtQednXBpIFCZCdbGl+v9cpdCXso=; b=pXEJBCIb7QVsfrxi/FVQb5pIr0zlA6y2PGqBBmBNHCfn9HEx39JXLRJV7gFvQ8ZrEiwl3B 9++A9f7if5FUY+3t7l3wKeWYg0Wo2yZbpB3e/94NcQb74bWxJ7lT6aBoXK5ZC1Mw730V6S TudtaSzIXFhxd70JKU39jQwnxMYcmA4= ARC-Authentication-Results: i=1; imf21.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=GfD6yi9M; spf=pass (imf21.hostedemail.com: domain of nphamcs@gmail.com designates 209.85.214.172 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=1673985614; a=rsa-sha256; cv=none; b=w/+xNVBHqvsF5NaEt/dFP4uZiR/E/m61d30I3aoO5nVLsYunRFm3wbOxfd0uPhLSMyeh1R bEhq+vkJ1Ahd6mFk/dNpfkfVnWmb2ugnxIWKRtJfVlHZ2sSEuEsvDp/+mDmRvg73Zlo0lR 25KiA65PJ/7fFMHCf9q5SqCfaajtj5Q= Received: by mail-pl1-f172.google.com with SMTP id g23so19063865plq.12 for ; Tue, 17 Jan 2023 12:00: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=lyKvDLCJcKSgVtBGtQednXBpIFCZCdbGl+v9cpdCXso=; b=GfD6yi9MvRGY4SS+EPgnSPa5YnBtZzSzmwO76/1e7AvCFkTrwFnDD6aKFGV6GUlPdE 3f0T52f10w90YQ7ARlRa+hZ27SQ/oHRHgQ4TVGnyyfQOYDtKw6/6sFqsVQfdQDeik75S pBR6V5KJeiyZL/BLaUrWnVUQl+YIGnzp+mxEiIglXCealZA/rZUtavo5ETxyKHZ5aVDm rDyDwjcyW2/Jfvo79ztQ+c8js0fMd4ZlLGGHl+9BK5LGGDn/vv7GWnP6Js2HoGnARZYk c965c8b/LuBzAI5C/dIj6lOkurpWhhmsKmKhd5vLLT1L3bL2+jdPq+GXpty5ggOy39Jw MgnQ== 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=lyKvDLCJcKSgVtBGtQednXBpIFCZCdbGl+v9cpdCXso=; b=rHhEKcjjhhyRLzfyaYeSEenlOzNdk25OcyOZMzfmxMVZo0WfBVo5/jI6AmKMCmtOJs ziqYphdMwC0x/xlBtTQc21y1ZBQaqg1YCfOV2FAzVAuAyEcYN2gX2rmMpvoqkMor8D6h hSu6r6tbJxGJOsy+cxeCaQDKvW09q6aMYFTF53of3l0VH9iV3Pm+pEAcp52dzASdOoYc 5xarLKWaSfjsqrrRz7oqbOz0fAQBHqmRQ88L4VHOa0Yk2RD3sPZEwPirRxvgzEiNHXnG snMaSDY48uBxoE9fENC5lujdF+Ce6MFCGyaeeQhHJtyDboIoqp4uKpr0dPoXdzB7w+oD ykAg== X-Gm-Message-State: AFqh2ko16nAujJNzhIcAxyBM02FSq7yEAnGWhPKZ3M/ZF+hES86bxzDl 54JSo2SPzG8Liq4bAHbQSHQ= X-Google-Smtp-Source: AMrXdXsUs6IugLRF39z6tWvMhxD2z1xV7FEZk9rVAJIywnkFG8PJV86udSJ3bPoclZLzywIMI0TxzQ== X-Received: by 2002:a17:902:f149:b0:194:810a:d6af with SMTP id d9-20020a170902f14900b00194810ad6afmr4182208plb.56.1673985613227; Tue, 17 Jan 2023 12:00:13 -0800 (PST) Received: from localhost (fwdproxy-prn-015.fbsv.net. [2a03:2880:ff:f::face:b00c]) by smtp.gmail.com with ESMTPSA id w3-20020a170902e88300b00189e7cb8b89sm4905457plg.127.2023.01.17.12.00.12 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 17 Jan 2023 12:00: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, linux-api@vger.kernel.org, kernel-team@meta.com Subject: [PATCH v6 2/3] cachestat: implement cachestat syscall Date: Tue, 17 Jan 2023 11:59:58 -0800 Message-Id: <20230117195959.29768-3-nphamcs@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230117195959.29768-1-nphamcs@gmail.com> References: <20230117195959.29768-1-nphamcs@gmail.com> MIME-Version: 1.0 X-Rspam-User: X-Rspamd-Server: rspam03 X-Stat-Signature: 5xeyb1yszdjq6fhgcq3k615guyjfc5hq X-Rspamd-Queue-Id: 738391C000D X-HE-Tag: 1673985614-959130 X-HE-Meta: U2FsdGVkX1+33vY4HV6R02LjTTmp3Eqkf7BzdKTsUWVWFlTPz6BxHVHnqA2FbTtBDh4GkPsIEf9d6pNPAqQ3BUqTPD7EjKDVkYUbeZHWHxq4lPl/ZFMEQ35Prl8nT1RpO8CC//wcNiu2TpBsf7ZRFJAh58DE7rzOQFyn3bXoiWbjf0sdiPU5ApuzMzHJVp4qwGFGlwkZo4CzqwBgQhKyiNctAAxEdaZvHxPcHQC4/Z8TdZhpScT01bWnIkzjW9Djgec43Ql59fps1jLYrXd8llIuSwispV0eP1PcxERdFFjN0dk9MeEBtHQrN8+M6cjtBNvb1FfuWeD1e+0bKZ8inccevUiXxg7X8z05KOUyS/sTUEvnJ75lO47w9ZwlWJpYwsXdR89O/zCnK6PGFQs16YsrzjZr6NYvns0PLJS/Q4B9jN632eMqOHxCyXzPlzT3+onMEpwFlEGbGUm5qgR3RrTGAf/J+tEd9q+9hhXHAoU/jMzBTgjiw2nU1zXzT//JwezT5vxtVow8vaeOqWT3BBBC9plnOhw35l1S3trKDeC3n1z8ovP/lZVyjvOEduvwghw6OoPu8TXxcftjMx+9dJIJ7fVCNmEXmSQg+8uSSS6hIzr/Th/ISRRiGouQ5QWfoKF0arkC6zoSmfqc5ly9iIJ4zYxPolbSL5ulXNSK0906ZOQ91z9a67fsxCMskI5IOEDtYsYvXhwJbDY5PYIOp9lbTT2zzBbBIWq1q9kaP0ZlaOfxJNuJ5Enam7hxyEeAUBvqmI5BvixJB0PoZnXimoL9R/5Q2PmnScCodux0On1Y2/sQ3nKtSpv9uQ0vWiu6KzANjy0+7a9+hYhRM2yOrSQXqtqUyVIvYfp1Z/SMEzdyYZZSkEzzKqhVfNs4e64zmelWMLpE1XxWeaQqX9lSI0o+S1VIn42SHeFpi22aCG+TSfh4brUvzT3lIq3Z+FxChlHlCMCuzHsLLkzVr+a pRwCeKsk 1vPeFmWRchx7940Ql9g0vn3I1FWUGUL/7msv6F3nPKCQdDOfejtCDzzlh97v2MAChtSYmnNXYT5SXi2PKeHPHZnlLEROCjItMDnaQDCQW2uS9py6v8J6x+9M098w+HHh63yPQ 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: 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 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. Signed-off-by: Nhat Pham Reviewed-by: Brian Foster --- 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 | 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 ++++++++++++++++++++ 20 files changed, 198 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..d3fe6ba8eb38 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,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 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..0305eaf5b3f5 100644 --- a/mm/filemap.c +++ b/mm/filemap.c @@ -22,6 +22,7 @@ #include #include #include +#include #include #include #include @@ -55,6 +56,13 @@ #include /* for try_to_free_buffers */ #include +#include + +#include "swap.h" + +#ifdef CONFIG_CACHESTAT_SYSCALL +#define LATEST_CACHESTAT_VERSION 1 +#endif /* * Shared mappings implemented 30.11.1994. It's not fully working yet, @@ -3949,3 +3957,149 @@ 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; + + goto resched; + } + + /* 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; + +resched: + if (need_resched()) { + xas_pause(&xas); + cond_resched_rcu(); + } + } + 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_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). + * + * 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, + unsigned int, cstat_version, 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 (!f.file) + return -EBADF; + + if (off < 0 || flags != 0 || cstat_version < 1 || + cstat_version > LATEST_CACHESTAT_VERSION) { + fdput(f); + return -EINVAL; + } + + 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, sizeof(struct cachestat))) + return -EFAULT; + + return 0; +} +#endif /* CONFIG_CACHESTAT_SYSCALL */ From patchwork Tue Jan 17 19:59:59 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nhat Pham X-Patchwork-Id: 13105019 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 05672C3DA78 for ; Tue, 17 Jan 2023 20:00:18 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 7E7266B0075; Tue, 17 Jan 2023 15:00:18 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 7709C6B0078; Tue, 17 Jan 2023 15:00:18 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 574BB6B007B; Tue, 17 Jan 2023 15:00:18 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0013.hostedemail.com [216.40.44.13]) by kanga.kvack.org (Postfix) with ESMTP id 467A36B0075 for ; Tue, 17 Jan 2023 15:00:18 -0500 (EST) Received: from smtpin23.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay09.hostedemail.com (Postfix) with ESMTP id C5EBF80B90 for ; Tue, 17 Jan 2023 20:00:17 +0000 (UTC) X-FDA: 80365357674.23.2D1C010 Received: from mail-pl1-f170.google.com (mail-pl1-f170.google.com [209.85.214.170]) by imf16.hostedemail.com (Postfix) with ESMTP id 0D70718001B for ; Tue, 17 Jan 2023 20:00:15 +0000 (UTC) Authentication-Results: imf16.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=HNk1t5ge; spf=pass (imf16.hostedemail.com: domain of nphamcs@gmail.com designates 209.85.214.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=1673985616; 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=OaOZQvWhqFGfMeSz4AFcJuI7rpVT7E7rM49XqO7Em38=; b=EwIHG8ftMItqM3TXY9W7lClTdg0zGkoH3WVJzn1Y49tppCsqp3fgHhHo+C3v3S7Dwb+Z8R xKUO5C2l1M7fy+brUv6LmgzjzuAMWUyyKEfy5q76QL2ZTOcgCQL0T4+Fdxf0U94kGFIyvP eKGYb7rqadZfuYPWUfYUdqqE3h/NsQ8= ARC-Authentication-Results: i=1; imf16.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=HNk1t5ge; spf=pass (imf16.hostedemail.com: domain of nphamcs@gmail.com designates 209.85.214.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=1673985616; a=rsa-sha256; cv=none; b=T/ayc1SMj9n8tbSvpqrMx2ds+IN/Z3qnuU/Jm5/+qNMkf9oA2dusoWkZwJQehlhq3s/I8H /jKBeBgTgZpgezHptLIHcl15wfcmEIadpvDf+28aU8TmeJaxCt0hSN5B5EvlM8Ui9qLxib wlHyTIiN1wd3n8+eW6EuYQr4oNZW4VQ= Received: by mail-pl1-f170.google.com with SMTP id b17so27149232pld.7 for ; Tue, 17 Jan 2023 12:00:15 -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=OaOZQvWhqFGfMeSz4AFcJuI7rpVT7E7rM49XqO7Em38=; b=HNk1t5geYxZUBRdjZ0SqtD+4givjGmCWUJlfv08yqi/RbwXADrjG6zSwXcPy5IdZvB Jut2oWQCIH/8Firu7DAVWKdln0NrDO3y1usX9vFcYejSCoB+taQGBNPxlU5cz6mcapJu JJhYSzwVzea8sth8DNY/xbTE0NZfzAwHMu9UhUEEJPPE3KU/TDAf2BLljdf/Mq+TvoGT tbBhe+BeEUKUiVUqRNGQPDSW6w8fWwdClsmrFTOVpMcCcnHm9mAzjkPc4bmP2t9n84uY 10gYjW3YaQphCM/wG/jPtD11Y3SkDOs9ZIiTTU0gnaEJPCLUnBx7At9vPzikyxbo4B62 laeg== 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=OaOZQvWhqFGfMeSz4AFcJuI7rpVT7E7rM49XqO7Em38=; b=ykJwDWpIaVeKklaZAEt5//QPGar1V+16nO1jw1FEASnG17dc5+yjjYhmaSdzrZKXNu jN6nafxtIlqTMCXQ/WXOjukeG6SRpyjMjhvwPa1EEe9xpD98pRrwMkOCc67wJ2A/TTjR E5kMYZtnl51Ah7G892DTn9QFqDo+E5tfpu/iWXqLSA8fToPGBMCF5XpmLVY5xI139XON xc+VuhRmEcdfCKxQLqPek4LnaLneJGwfQcUalxulRP01U7hTCOYqhiF3tmoYILUZ56u8 S2LfTyLDHHJ/XDzSAW6oKQnZLyqCCRchKTEPv5bCwPUc3kbgvmaBgpWO9wKrpdrgDd3B WfBQ== X-Gm-Message-State: AFqh2kpYbweVnrllv8Wg6jqdIoJ2qf6xcorQJ54AG7ap0Pg/mkA6TeJh twIZn2mqkBP7oTdHwnkJ6nc= X-Google-Smtp-Source: AMrXdXvOpo4sFO++TFPpPhGEYiSachbNbxG3BW69unObKCWuL0LUt5811XrfTPJZx9lp0zJ5cWC0bQ== X-Received: by 2002:a05:6a21:7890:b0:b8:827c:42bd with SMTP id bf16-20020a056a21789000b000b8827c42bdmr5199470pzc.17.1673985614738; Tue, 17 Jan 2023 12:00:14 -0800 (PST) Received: from localhost (fwdproxy-prn-022.fbsv.net. [2a03:2880:ff:16::face:b00c]) by smtp.gmail.com with ESMTPSA id h18-20020a656392000000b0046b1dabf9a8sm17676764pgv.70.2023.01.17.12.00.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 17 Jan 2023 12:00:14 -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, linux-api@vger.kernel.org, kernel-team@meta.com Subject: [PATCH v6 3/3] selftests: Add selftests for cachestat Date: Tue, 17 Jan 2023 11:59:59 -0800 Message-Id: <20230117195959.29768-4-nphamcs@gmail.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230117195959.29768-1-nphamcs@gmail.com> References: <20230117195959.29768-1-nphamcs@gmail.com> MIME-Version: 1.0 X-Stat-Signature: fygyffn57wsmfrdgqnicuf47yihn5hro X-Rspam-User: X-Rspamd-Queue-Id: 0D70718001B X-Rspamd-Server: rspam06 X-HE-Tag: 1673985615-538331 X-HE-Meta: U2FsdGVkX18CvPTZ9g7hMyWPvJgWNggDnv1mLYdQAPekE8LkBQ8eCt3m5/ySyBIrPBaBKsegaid4c/FdtJIa+XtVAh3iOBXILItoG7ej57PCtSvL/2nRql22IvNctr+VYQ6IC8ssHZPpsfyu6cLIA095EdBnNxb1xfZvda/AWtYJumE8RKrjcDOTMB2IofE/3cqchAbAvCt3wxm2vT4JD3mmoct5QBY2j0h/JyW1lIp7h5liA7VJhkR9jRkc/6bqFqHPvgDcnsdQ/ZOHghN0EgZQFfDaNlhWZX5i96C3QZMiY7VirhzewpgBMcxSQeCcXI6hYqInBED3ppd7ol/LePnAJOarlFtfeYQBowqfNwc9GDNbGJ7xWco3Dfu5xHSGM2A5OpaalwFEfHS7wxGvRSsJtE3Ovrjaf9tkrlgpWJG2CPZ6AGF8CdWWoQZ/K37uSAGzahkG2fG8xtggPnzcW1aV5mr5xjErDnZinugHAatMu4i8hk9IdQhL3bl8s2fOyI8rng49wQc/J29/G1PojCk+0AUvK3PjdRKlPsajLwLecY91Flu1wcz/Z/JeyfHH9SXhm32n6SWLb/51sJb5DxLrirj+lXfPmqWTi+jIEsV7rBwgSrFxyKJfqSVDKdwMB96E5hRoRxlqg9wzcPEr7wYIeN9YumGWISz5lzPstIwDXQLPGJEtaFl8pSIYuhBfXBz24+QztTzQf91FqvMVfoF+g0O53hjG4a6rmolLmocp3YGr7tIqodmChWfzfzpreWWZdyFkjvrCmpmbzIZSOonlqA9qNK5PRqqpN0a2ikRGyDIK65LpkXAEMsf6WZ66lnxF3McuClaR7Fl9bLuhAl5+jRdH1XCfXaRsnykdlABffcvSmFMT7cavlGBVwXuCSawlMObxlyU5WXPCDed8LS4jD+hlIaZaLfqnOm04PpyN29BUI8EyDrhvwgWS2IrOZcPKGVcrHXlN7s7TJy6 PmM36X7S SgAt+r6sX7TgyVvoiRoZcCLPivkq/QKZAJsop6wuDCPPkd0kwtNhkIWYbgVBDGtN0QnzSSRSWkUeFTyWlRrXhWTjG3QH80+dhcKdpdv/8eoyMPgduArWwyjfoFrzYrRKu5FMZ 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: 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). Signed-off-by: Nhat Pham --- 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 diff --git a/MAINTAINERS b/MAINTAINERS index a198da986146..792a866353ec 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: tools/testing/selftests/cachestat/test_cachestat.c + CADENCE MIPI-CSI2 BRIDGES M: Maxime Ripard L: linux-media@vger.kernel.org diff --git a/tools/testing/selftests/Makefile b/tools/testing/selftests/Makefile index 0464b2c6c1e4..3cad0b38c5c2 100644 --- a/tools/testing/selftests/Makefile +++ b/tools/testing/selftests/Makefile @@ -4,6 +4,7 @@ TARGETS += amd-pstate TARGETS += arm64 TARGETS += bpf TARGETS += breakpoints +TARGETS += cachestat TARGETS += capabilities TARGETS += cgroup TARGETS += clone3 diff --git a/tools/testing/selftests/cachestat/.gitignore b/tools/testing/selftests/cachestat/.gitignore new file mode 100644 index 000000000000..d6c30b43a4bb --- /dev/null +++ b/tools/testing/selftests/cachestat/.gitignore @@ -0,0 +1,2 @@ +# SPDX-License-Identifier: GPL-2.0-only +test_cachestat diff --git a/tools/testing/selftests/cachestat/Makefile b/tools/testing/selftests/cachestat/Makefile new file mode 100644 index 000000000000..fca73aaa7d14 --- /dev/null +++ b/tools/testing/selftests/cachestat/Makefile @@ -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 diff --git a/tools/testing/selftests/cachestat/test_cachestat.c b/tools/testing/selftests/cachestat/test_cachestat.c new file mode 100644 index 000000000000..dc2894028eee --- /dev/null +++ b/tools/testing/selftests/cachestat/test_cachestat.c @@ -0,0 +1,260 @@ +// SPDX-License-Identifier: GPL-2.0 +#define _GNU_SOURCE + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "../kselftest.h" + +static const char * const dev_files[] = { + "/dev/zero", "/dev/null", "/dev/urandom", + "/proc/version", "/proc" +}; +static const int cachestat_nr = 451; +static const int cstat_version = 1; /* first version */ + +void print_cachestat(struct cachestat *cs) +{ + ksft_print_msg( + "Using cachestat: Cached: %lu, Dirty: %lu, Writeback: %lu, Evicted: %lu, Recently Evicted: %lu\n", + cs->nr_cache, cs->nr_dirty, cs->nr_writeback, + cs->nr_evicted, cs->nr_recently_evicted); +} + +bool write_exactly(int fd, size_t filesize) +{ + char data[filesize]; + bool ret = true; + int random_fd = open("/dev/urandom", O_RDONLY); + + if (random_fd < 0) { + ksft_print_msg("Unable to access urandom.\n"); + ret = false; + goto out; + } else { + int remained = filesize; + char *cursor = data; + + while (remained) { + ssize_t read_len = read(random_fd, cursor, remained); + + if (read_len <= 0) { + ksft_print_msg("Unable to read from urandom.\n"); + ret = false; + goto close_random_fd; + } + + remained -= read_len; + cursor += read_len; + } + + /* write random data to fd */ + remained = filesize; + cursor = data; + while (remained) { + ssize_t write_len = write(fd, cursor, remained); + + if (write_len <= 0) { + ksft_print_msg("Unable write random data to file.\n"); + ret = false; + goto close_random_fd; + } + + remained -= write_len; + cursor += write_len; + } + } + +close_random_fd: + close(random_fd); +out: + return ret; +} + +/* + * Open/create the file at filename, (optionally) write random data to it + * (exactly num_pages), then test the cachestat syscall on this file. + * + * If test_fsync == true, fsync the file, then check the number of dirty + * pages. + */ +bool test_cachestat(const char *filename, bool write_random, bool create, + bool test_fsync, unsigned long num_pages, int open_flags, + mode_t open_mode) +{ + size_t PS = sysconf(_SC_PAGESIZE); + int filesize = num_pages * PS; + bool ret = true; + long syscall_ret; + struct cachestat cs; + + int fd = open(filename, open_flags, open_mode); + + if (fd == -1) { + ksft_print_msg("Unable to create/open file.\n"); + goto out; + } else { + ksft_print_msg("Create/open %s\n", filename); + } + + if (write_random) { + if (!write_exactly(fd, filesize)) { + ksft_print_msg("Unable to access urandom.\n"); + ret = false; + goto out1; + } + } + + syscall_ret = syscall(cachestat_nr, fd, 0, filesize, + cstat_version, &cs, 0); + + ksft_print_msg("Cachestat call returned %ld\n", syscall_ret); + + if (syscall_ret) { + ksft_print_msg("Cachestat returned non-zero.\n"); + ret = false; + goto out1; + + } else { + print_cachestat(&cs); + + if (write_random) { + if (cs.nr_cache + cs.nr_evicted != num_pages) { + ksft_print_msg( + "Total number of cached and evicted pages is off.\n"); + ret = false; + } + } + } + + if (test_fsync) { + if (fsync(fd)) { + ksft_print_msg("fsync fails.\n"); + ret = false; + } else { + syscall_ret = syscall(cachestat_nr, fd, 0, filesize, + cstat_version, &cs, 0); + + ksft_print_msg("Cachestat call (after fsync) returned %ld\n", + syscall_ret); + + if (!syscall_ret) { + print_cachestat(&cs); + + if (cs.nr_dirty) { + ret = false; + ksft_print_msg( + "Number of dirty should be zero after fsync.\n"); + } + } else { + ksft_print_msg("Cachestat (after fsync) returned non-zero.\n"); + ret = false; + goto out1; + } + } + } + +out1: + close(fd); + + if (create) + remove(filename); +out: + return ret; +} + +bool test_cachestat_shmem(void) +{ + size_t PS = sysconf(_SC_PAGESIZE); + size_t filesize = PS * 512 * 2; /* 2 2MB huge pages */ + int syscall_ret; + off_t off = PS; + size_t compute_len = PS * 512; + char *filename = "tmpshmcstat"; + struct cachestat cs; + bool ret = true; + unsigned long num_pages = compute_len / PS; + int fd = shm_open(filename, O_CREAT | O_RDWR, 0600); + + if (fd < 0) { + ksft_print_msg("Unable to create shmem file.\n"); + ret = false; + goto out; + } + + if (ftruncate(fd, filesize)) { + ksft_print_msg("Unable to trucate shmem file.\n"); + ret = false; + goto close_fd; + } + + if (!write_exactly(fd, filesize)) { + ksft_print_msg("Unable to write to shmem file.\n"); + ret = false; + goto close_fd; + } + + syscall_ret = syscall(cachestat_nr, fd, off, compute_len, + cstat_version, &cs, 0); + + if (syscall_ret) { + ksft_print_msg("Cachestat returned non-zero.\n"); + ret = false; + goto close_fd; + } else { + print_cachestat(&cs); + if (cs.nr_cache + cs.nr_evicted != num_pages) { + ksft_print_msg( + "Total number of cached and evicted pages is off.\n"); + ret = false; + } + } + +close_fd: + shm_unlink(filename); +out: + return ret; +} + +int main(void) +{ + int ret = 0; + + for (int i = 0; i < 5; i++) { + const char *dev_filename = dev_files[i]; + + if (test_cachestat(dev_filename, false, false, false, + 4, O_RDONLY, 0400)) + ksft_test_result_pass("cachestat works with %s\n", dev_filename); + else { + ksft_test_result_fail("cachestat fails with %s\n", dev_filename); + ret = 1; + } + } + + if (test_cachestat("tmpfilecachestat", true, true, + true, 4, O_CREAT | O_RDWR, 0400 | 0600)) + ksft_test_result_pass("cachestat works with a normal file\n"); + else { + ksft_test_result_fail("cachestat fails with normal file\n"); + ret = 1; + } + + if (test_cachestat_shmem()) + ksft_test_result_pass("cachestat works with a shmem file\n"); + else { + ksft_test_result_fail("cachestat fails with a shmem file\n"); + ret = 1; + } + + return ret; +}