From patchwork Wed Mar 8 03:27:46 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nhat Pham X-Patchwork-Id: 65998 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:5915:0:0:0:0:0 with SMTP id v21csp113181wrd; Tue, 7 Mar 2023 19:31:21 -0800 (PST) X-Google-Smtp-Source: AK7set8EwR4F1xPK2pxXwxfsImHDEjWig/r194FEUbZe549SPKBF/h9CwlS1utg2/wc6QQVT2w7b X-Received: by 2002:a17:90b:38d2:b0:237:50a9:e7c9 with SMTP id nn18-20020a17090b38d200b0023750a9e7c9mr18574384pjb.15.1678246281210; Tue, 07 Mar 2023 19:31:21 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1678246281; cv=none; d=google.com; s=arc-20160816; b=C99CJ1usOzZZMnK8i23h6h3P5h0/Y8QPfZTXo77VffkHk73GbPkBaZg4h+PG94QAuF 7+oVsBSk4L2wJScAbxhbc3A1TSAQhvlqNqDkPXQdcKarTSod5bIV+YQVN+lfrJAUQpFI zPTu0AGPHeOOCAPuUshHRiVRt2xnY7o5uIJP7Jx1/LbpAbrRaFy1kQR56Gvv7EdJf3vZ L7yRsHr+dWWKvjRgQj9no0vO+b2s+7NU3xPbe0xdUz5hWZ/4a/MZUViwY5mxU1fMURPc +ic295HMl53RWURNB1hSnaCPNIkXRViICn3v4XhJdR9hX/uMhcraBv8mkbWqPiV4dNKM oq4w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=MG+emPX7mJCXZkl6Cr6yWLCcFG6GIk8J4ic4wm50wUs=; b=RIwyxqNIHhti4RDI/q+bOr1iuFw6AGn7Onm2yOmKVisK2sQCRmPZtoyujhUaXj2AYP YQIUfqIYT381QJ3hOCqKko1jKeFP4KemkPer0YdH98pEK0pTONC3nnopAz+JW5bfKhok PAgTmGVqoZo2vaH6auiNRkZlCrUI3CMfJ7QHDNMrY9efuINHX0+O3GtLI8JwK1PKbagS yNEnTaZClApEFcH7MKA7iCR7Il0WPe6uQh+dsBD3D5s1KQElP0Jd+hlfOeGTFGUGgxj1 eDyjUOhGSzyafGCURrSECtnTLdZsGcNdTIUyoyaSKCLclEnKzu5TUVSOZJKt6yz0m40N m8ZQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b="gwHanh3/"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id m14-20020a17090ade0e00b00234ac93d720si13682372pjv.30.2023.03.07.19.31.08; Tue, 07 Mar 2023 19:31:21 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b="gwHanh3/"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229770AbjCHD2C (ORCPT + 99 others); Tue, 7 Mar 2023 22:28:02 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57276 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229815AbjCHD17 (ORCPT ); Tue, 7 Mar 2023 22:27:59 -0500 Received: from mail-pg1-x52c.google.com (mail-pg1-x52c.google.com [IPv6:2607:f8b0:4864:20::52c]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 71C4C7ECF; Tue, 7 Mar 2023 19:27:55 -0800 (PST) Received: by mail-pg1-x52c.google.com with SMTP id s18so8901580pgq.1; Tue, 07 Mar 2023 19:27:55 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; t=1678246075; 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=MG+emPX7mJCXZkl6Cr6yWLCcFG6GIk8J4ic4wm50wUs=; b=gwHanh3/+3jcVMEXte6zwnnreeVvlAGntpzYNNlhQ3m0tM9wm7rWZzX7U3mOYKnI/r gjdqy1lNCmj2OYl8DKQgkHxbKczJufnikis0x1b86T8GU4e3i94QJZ5a5HL9aIB38VX+ hEWTMAIgzfTcUOehNXKDs7QZSWS3ZNnchiuMrc32ApZpQEp7+q9UC+sXuwLl1qO7m6di 1wokNPuwJdUt/Q+DinlBURSAeMNMf8zccw1y10ipzzIxcxUnUsFLRcCf15qST/rY1ya9 Z+xpnSqpq07lJTLhPqtasbunr0kNPJJ76TrNF9Ha/Ydzhv4xQHKxdKuZmySazyQ5CYB3 mI4Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1678246075; 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=MG+emPX7mJCXZkl6Cr6yWLCcFG6GIk8J4ic4wm50wUs=; b=cDCdbM9mBuf34aqWS2YBGXa9m/DyYA0Li4pac5ce2drUWoriWUllSI1mlpy7xptjPv NUA7ZAl2FbAkI4Z9prpfVPuLsMLYw401k0N2OJxiGju6J3AoyteYd/SLEMLu5bMCwsLs 0co12o2/ClhShh0jowUTU/OEXf3yWboMpRbGgyPfzarqklmo6XVNmD5UCHlGXhn/x0g4 GR7OF3ul0u1F2UU8tYYSh/UUqAGDPzAb0ZuAjHAkn0B+XJKsK2rCEwSZ5k62WfBCHShh g4puCziAAQOWMTcP7hQj+OMIgLPJcguLT6bkJCEA8CbSVicrgO9g2UH8EijB3jqSsvOe dkbw== X-Gm-Message-State: AO0yUKUjh0WzBnqbvBfetl09Cq7r2juBX2O9DiKSn2I8382okOu5iDNV eV6kX/tW0W10jS3Rxw6CK9M= X-Received: by 2002:a05:6a00:cd:b0:5a8:cbcc:4b58 with SMTP id e13-20020a056a0000cd00b005a8cbcc4b58mr16717628pfj.12.1678246074792; Tue, 07 Mar 2023 19:27:54 -0800 (PST) Received: from localhost ([113.161.42.54]) by smtp.gmail.com with ESMTPSA id v24-20020a62a518000000b005dca6f0046dsm8827078pfm.12.2023.03.07.19.27.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 07 Mar 2023 19:27:54 -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, arnd@arndb.de, linux-api@vger.kernel.org, kernel-team@meta.com Subject: [PATCH v11 1/3] workingset: refactor LRU refault to expose refault recency check Date: Tue, 7 Mar 2023 19:27:46 -0800 Message-Id: <20230308032748.609510-2-nphamcs@gmail.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230308032748.609510-1-nphamcs@gmail.com> References: <20230308032748.609510-1-nphamcs@gmail.com> MIME-Version: 1.0 X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1759768772217943105?= X-GMAIL-MSGID: =?utf-8?q?1759768772217943105?= 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 | 145 +++++++++++++++++++++++++++++-------------- 2 files changed, 100 insertions(+), 46 deletions(-) -- 2.39.2 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..a60729c1b766 100644 --- a/mm/workingset.c +++ b/mm/workingset.c @@ -244,6 +244,29 @@ static void *lru_gen_eviction(struct folio *folio) return pack_shadow(mem_cgroup_id(memcg), pgdat, token, refs); } +/* + * Tests if the shadow entry is for a folio that was recently evicted. + * Fills in @memcgid, @pglist_data, @token, @workingset with the values + * unpacked from shadow. + */ +static bool lru_gen_test_recent(void *shadow, bool file, int *memcgid, + struct pglist_data **pgdat, unsigned long *token, bool *workingset) +{ + struct mem_cgroup *eviction_memcg; + struct lruvec *lruvec; + struct lru_gen_struct *lrugen; + unsigned long min_seq; + + 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; @@ -258,23 +281,22 @@ static void lru_gen_refault(struct folio *folio, void *shadow) int type = folio_is_file_lru(folio); int delta = folio_nr_pages(folio); - unpack_shadow(shadow, &memcg_id, &pgdat, &token, &workingset); - - if (pgdat != folio_pgdat(folio)) - return; - rcu_read_lock(); + if (!lru_gen_test_recent(shadow, type, &memcg_id, &pgdat, &token, + &workingset)) + goto unlock; + memcg = folio_memcg_rcu(folio); if (memcg_id != mem_cgroup_id(memcg)) goto unlock; + if (pgdat != folio_pgdat(folio)) + return; + lruvec = mem_cgroup_lruvec(memcg, pgdat); lrugen = &lruvec->lrugen; - min_seq = READ_ONCE(lrugen->min_seq[type]); - if ((token >> LRU_REFS_WIDTH) != (min_seq & (EVICTION_MASK >> LRU_REFS_WIDTH))) - goto unlock; hist = lru_hist_from_seq(min_seq); /* see the comment in folio_lru_refs() */ @@ -306,6 +328,12 @@ static void *lru_gen_eviction(struct folio *folio) return NULL; } +static bool lru_gen_test_recent(void *shadow, bool file, int *memcgid, + struct pglist_data **pgdat, unsigned long *token, bool *workingset) +{ + return false; +} + static void lru_gen_refault(struct folio *folio, void *shadow) { } @@ -374,39 +402,34 @@ void *workingset_eviction(struct folio *folio, struct mem_cgroup *target_memcg) } /** - * 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. + * workingset_test_recent - tests if the shadow entry is for a folio that was + * recently evicted. Also fills in @workingset with the value unpacked from + * shadow. + * @shadow: the shadow entry to be tested. + * @file: whether the corresponding folio is from the file lru. + * @workingset: where the workingset value unpacked from shadow should + * be stored. + * + * Return: true if the shadow is for a recently evicted folio; false otherwise. */ -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, &memcgid, &pgdat, &eviction, + 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,7 +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(); + + /* + * 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); + + if (!workingset_test_recent(shadow, file, &workingset)) goto out; folio_set_active(folio); From patchwork Wed Mar 8 03:27:47 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nhat Pham X-Patchwork-Id: 66000 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:5915:0:0:0:0:0 with SMTP id v21csp116578wrd; Tue, 7 Mar 2023 19:41:33 -0800 (PST) X-Google-Smtp-Source: AK7set8UyZ7jEDRDPxNmCvBo0uFwtdC81Oo06HG17yyKArDcfT5B/FUjS/I8oC3JIic48E7xJVrb X-Received: by 2002:a17:906:b007:b0:8aa:c038:974c with SMTP id v7-20020a170906b00700b008aac038974cmr15706556ejy.54.1678246893493; Tue, 07 Mar 2023 19:41:33 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1678246893; cv=none; d=google.com; s=arc-20160816; b=Dn0IxTvVbdKhC6wEQXhj3xod3R+7pKBKfXOeRf8r11uxaiB9c/Z0TakGUPfjHFVAmc ME5khHDD1WQ1zg8uKbxDC3G/iom4gsFvKuC/JzhAb1BPYYId/q7r9imX2NUyOj4YWIJU p7mkZ+/g9oV4wU3xYabGXXcLuPOMZVbH3hHIdyvTpmWu9kVLvpZJcBf8WAieGZ7+Pcey LB5ZAcSBjuPGdGrcuSEoIlVwueYHAS2WX+RHanuVH0pG0jC8Ltg60wT5kMv+omCIATJ0 Ye5MqODV+KbmLn2Iox6v9pt9JooMkadO5YD6CZ/QSkNEYpKutOQcH1cdd8Uy26x46NBh 8DsA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=rQLAV84gMFsV3LxWJw1TSpJEIK+pmCzDLoebKmfQ52s=; b=qoae0TkF9VubsCOypIwl8am67nuaRvHo+mbOQfaOILBnb2quR8PeNXH3SSYCJa2ViM Ny5IJVOu5MtDvYcoLLNngjehWC5xlp9iqyS2tcctotuReGUPEs4DvAIG+WJlFYo8Pf49 KlMXf6+/gOYDqWDu4hPcXmt73mBPuTmAjpRDWTkoOFzB1MKh8c11qg6hfCAi9fieFNtA 3L1CBDhy3wC+6Ziuz2wcYqKMYn4l29rmwrzG7tuoB0PelXldA/pDdZMYTydLmsT/4lOv qisYzT/Y7/wN63AEoqsJ/Z5/yED41zNx8AjrgZrWSbGhrjRP1KK/Y08Wd20pAFDUvjTz 8Nhg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=LmRZu8nw; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id m2-20020a1709062ac200b008dfe8ec40cesi1074166eje.917.2023.03.07.19.40.25; Tue, 07 Mar 2023 19:41:33 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=LmRZu8nw; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229918AbjCHD2L (ORCPT + 99 others); Tue, 7 Mar 2023 22:28:11 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57358 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229827AbjCHD2B (ORCPT ); Tue, 7 Mar 2023 22:28:01 -0500 Received: from mail-pl1-x635.google.com (mail-pl1-x635.google.com [IPv6:2607:f8b0:4864:20::635]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 51D44136EC; Tue, 7 Mar 2023 19:27:58 -0800 (PST) Received: by mail-pl1-x635.google.com with SMTP id p20so16406382plw.13; Tue, 07 Mar 2023 19:27:58 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; t=1678246078; 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=rQLAV84gMFsV3LxWJw1TSpJEIK+pmCzDLoebKmfQ52s=; b=LmRZu8nwWGEMwcaxmfwWjHQx4zti/OVBe3Zg31Y2vov4PUafukvhyunJedbmV+c8wv +cM/3bzNDQAY9EWuckUl17yPRPsAMQHGsrvsephzPNaYNv8DYHJpbr2sNPiNZgm40zIv x6qUdeJmXM5hT9RsPcHxVv4DC6HTvtRrGuV3n3zGR/nItLq9cplBIB1TFnmspzSiuPAH 3QW+gJSkgc+GnhuotMEd1p5WEMh0nKqY+JyTzVTOfN3e+oU7ybO7DUpgBMRTn0TE8YVr cZcwDl+BztZ6n84vLlXMGEwm9VCIVkVK8BD14nSUI+nW9zgB0WARHp11hbM59f4mWn7Z pOxQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1678246078; 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=rQLAV84gMFsV3LxWJw1TSpJEIK+pmCzDLoebKmfQ52s=; b=Exqo5ve8XDRsC4qZLITcmTm15B8z4lztIfqV9+ZQnbTcjSWjCW1R6lgFH8mWTJEqXK 4xYjkxjftJZYjGQBz/d41zY6+KkdB3sBc7c3Nv9hOJ6PGYLMoUnk34XJyW3X8qTKDnZ/ S5NYTAzF1IfkJpGRlOEQ7Zr4Z5uEAidRgj7GHyNPcJQ6M93ZyAOMgKASgbWQhqAASBr1 tbuQb9TrDM7U4+Rdq42GW50HoIKig7Uw4Fn/ZdwiAca8C/AOsDZ7oKV5uT48Xn7+oBEt J2XTAM2GEUKwUBSTRd3JxCnLdfNR1R9qaLFxgppbaPC823tB2kE2xKl/IfB5Bcp/W+rH mNHg== X-Gm-Message-State: AO0yUKUeeSWESvy9NcdTR71cdof1eWOBuCPCkqbmlktPXliaUlGDCAwb Ag/N8B1SaBJaBxc22VYVam9+7FkKZ1St3zod X-Received: by 2002:a17:902:c40a:b0:19a:5958:15e7 with SMTP id k10-20020a170902c40a00b0019a595815e7mr17686556plk.15.1678246077570; Tue, 07 Mar 2023 19:27:57 -0800 (PST) Received: from localhost ([113.161.42.54]) by smtp.gmail.com with ESMTPSA id ks3-20020a170903084300b0019c901c207dsm9051703plb.177.2023.03.07.19.27.56 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 07 Mar 2023 19:27:57 -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, arnd@arndb.de, linux-api@vger.kernel.org, kernel-team@meta.com Subject: [PATCH v11 2/3] cachestat: implement cachestat syscall Date: Tue, 7 Mar 2023 19:27:47 -0800 Message-Id: <20230308032748.609510-3-nphamcs@gmail.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230308032748.609510-1-nphamcs@gmail.com> References: <20230308032748.609510-1-nphamcs@gmail.com> MIME-Version: 1.0 X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1759769414524054474?= X-GMAIL-MSGID: =?utf-8?q?1759769414524054474?= There is currently no good way to query the page cache state of large file sets and directory trees. There is mincore(), but it scales poorly: the kernel writes out a lot of bitmap data that userspace has to aggregate, when the user really doesn not care about per-page information in that case. The user also needs to mmap and unmap each file as it goes along, which can be quite slow as well. This patch implements a new syscall that queries cache state of a file and summarizes the number of cached pages, number of dirty pages, number of pages marked for writeback, number of (recently) evicted pages, etc. in a given range. Currently, the syscall is only wired in for x86 architecture. NAME cachestat - query the page cache statistics of a file. SYNOPSIS #include struct cachestat { __u64 nr_cache; __u64 nr_dirty; __u64 nr_writeback; __u64 nr_evicted; __u64 nr_recently_evicted; }; int cachestat(unsigned int fd, size_t len, loff_t off, struct cachestat *cstat, unsigned int flags); DESCRIPTION cachestat() queries the number of cached pages, number of dirty pages, number of pages marked for writeback, number of evicted pages, number of recently evicted pages, in the bytes range given by `off` and `len`. An evicted page is a page that is previously in the page cache but has been evicted since. A page is recently evicted if its last eviction was recent enough that its reentry to the cache would indicate that it is actively being used by the system, and that there is memory pressure on the system. These values are returned in a cachestat struct, whose address is given by the `cstat` argument. The `off` and `len` arguments must be non-negative integers. If `len` > 0, the queried range is [`off`, `off` + `len`]. If `len` == 0, we will query in the range from `off` to the end of the file. The `flags` argument is unused for now, but is included for future extensibility. User should pass 0 (i.e no flag specified). Currently, hugetlbfs is not supported. 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 VALUE On success, cachestat returns 0. On error, -1 is returned, and errno is set to indicate the error. ERRORS EFAULT cstat points to an invalid address. EINVAL invalid offset or flags. EBADF invalid file descriptor. EOPNOTSUPP file descriptor is of a hugetlbfs file Signed-off-by: Nhat Pham --- arch/x86/entry/syscalls/syscall_32.tbl | 1 + arch/x86/entry/syscalls/syscall_64.tbl | 1 + include/linux/compat.h | 5 +- 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 | 166 +++++++++++++++++++++++++ 9 files changed, 199 insertions(+), 2 deletions(-) -- 2.39.2 diff --git a/arch/x86/entry/syscalls/syscall_32.tbl b/arch/x86/entry/syscalls/syscall_32.tbl index 320480a8db4f..01d1cc009250 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 compat_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/include/linux/compat.h b/include/linux/compat.h index 594357881b0b..c0f4628c2b4f 100644 --- a/include/linux/compat.h +++ b/include/linux/compat.h @@ -816,7 +816,10 @@ asmlinkage long compat_sys_sendmsg(int fd, struct compat_msghdr __user *msg, asmlinkage long compat_sys_recvmsg(int fd, struct compat_msghdr __user *msg, unsigned int flags); -/* mm/filemap.c: No generic prototype for readahead */ +/* mm/filemap.c */ +asmlinkage long compat_sys_cachestat(unsigned int fd, size_t len, + compat_arg_u64(off), struct cachestat __user *cstat, + unsigned int flags); /* security/keys/keyctl.c */ asmlinkage long compat_sys_keyctl(u32 option, diff --git a/include/linux/syscalls.h b/include/linux/syscalls.h index a34b0f9a9972..9f384a6d7e77 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, size_t len, loff_t offset, + 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..dc5fcfee7f09 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 +__SC_COMP(__NR_cachestat, sys_cachestat, compat_sys_cachestat) + #undef __NR_syscalls -#define __NR_syscalls 451 +#define __NR_syscalls 452 /* * 32 bit systems traditionally used different 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..768b95ea551c 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,165 @@ 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. + */ +static 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 pages */ + 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(); +} + +#ifdef CONFIG_CACHESTAT_SYSCALL +long ksys_cachestat(unsigned int fd, size_t len, loff_t off, + 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; + + /* hugetlbfs is not supported */ + if (is_file_hugepages(f.file)) { + fdput(f); + return -EOPNOTSUPP; + } + + if (off < 0 || flags != 0) { + 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; +} + +/* + * 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. + * + * The `flags` argument is unused for now, but is included for future + * extensibility. User should pass 0 (i.e no flag specified). + * + * Currently, hugetlbfs is not supported. + * + * 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 + * -EOPNOTSUPP - file descriptor is of a hugetlbfs file + */ +SYSCALL_DEFINE5(cachestat, unsigned int, fd, size_t, len, loff_t, off, + struct cachestat __user *, cstat, unsigned int, flags) +{ + return ksys_cachestat(fd, len, off, cstat, flags); +} + +#ifdef CONFIG_COMPAT +COMPAT_SYSCALL_DEFINE6(cachestat, unsigned int, fd, size_t, len, + compat_arg_u64_dual(off), struct cachestat __user *, cstat, + unsigned int, flags) +{ + return ksys_cachestat(fd, len, compat_arg_u64_glue(off), cstat, flags); +} +#endif +#endif /* CONFIG_CACHESTAT_SYSCALL */ From patchwork Wed Mar 8 03:27:48 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nhat Pham X-Patchwork-Id: 66002 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:5915:0:0:0:0:0 with SMTP id v21csp116894wrd; Tue, 7 Mar 2023 19:42:19 -0800 (PST) X-Google-Smtp-Source: AK7set9JTIKZYdgcuO0rr1kPbn6UDb6Lq91vm//9F466CEvyhVs8Rfk/mz5TUAkL61cI3TySudPD X-Received: by 2002:a17:907:c283:b0:870:b950:18d4 with SMTP id tk3-20020a170907c28300b00870b95018d4mr18017162ejc.5.1678246939720; Tue, 07 Mar 2023 19:42:19 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1678246939; cv=none; d=google.com; s=arc-20160816; b=JDxDGGIeUN4gILPyxfuWldQgcy9rj50t5dMnQ3c6J6UW0FTS9TWgwmRQgUFE3c3PXS vuwnnEn0GQNbqGT3vHaveX6FzuQwwRB7aD7x8tlfYo+lKoF0kGqfyCY25v87rRbdLlN4 tw0bjhPqcogtqQCEG55MHUw95JN2WI6QKhPbd4cPo2Zr9LW/hE9KFjPDGPGpoNMymMZx SxwGGc7oA4jhAZ+bA69nC7LPjttm3371c957dIQB7MvRkuOsWogEzBvI/13jbihRwyTV OFyedAcfrFXiLZyzhO1vEyrxMhY7tosdHSDV37iDtb5w44WFBaOYUZ7mJi+lNxCQyYXH axKQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=ZJj61gxvsnAstCshIubsPwP+A0RbNepTL+cBruG18fI=; b=rzwRpgAv7H9q2CVQQuKq2FBHNH3vudlVpbqhd2oTqAb3tDbJ7DKV0zy5Vj2x1twYjB 4V4XDs9iG+qOU5LNMbIePh+TVGUiLKfHnQgjzpamjnxV4hzm5Qwv/GXROUSPhtuduUuy eNGgVtRLKA+0ebhmpnjzv8Omhhp1CrGzD5lGQ4irNZiPxLhwqsOa0QENKesi+iQGE/wf j0A+3QfBzZImdaB8bwQjZj7rK2h4QTTCfm+CxBGd1OvDB5Z92isaEm9UBFOo3HBroB9m YWo5O4oh3dKxW8XuPr1jyvTIax8tJVuf88r7s7CmdIeA9TV3ABsX7fsaWezPdCraukIp uM+w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=kUKIsUtS; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id sh43-20020a1709076eab00b008d3be841cdfsi2210918ejc.38.2023.03.07.19.41.55; Tue, 07 Mar 2023 19:42:19 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=kUKIsUtS; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229953AbjCHD2O (ORCPT + 99 others); Tue, 7 Mar 2023 22:28:14 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57502 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229815AbjCHD2E (ORCPT ); Tue, 7 Mar 2023 22:28:04 -0500 Received: from mail-pj1-x1032.google.com (mail-pj1-x1032.google.com [IPv6:2607:f8b0:4864:20::1032]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9830D38643; Tue, 7 Mar 2023 19:28:01 -0800 (PST) Received: by mail-pj1-x1032.google.com with SMTP id h11-20020a17090a2ecb00b00237c740335cso747410pjs.3; Tue, 07 Mar 2023 19:28:01 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; t=1678246081; 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=ZJj61gxvsnAstCshIubsPwP+A0RbNepTL+cBruG18fI=; b=kUKIsUtSoY9R865fkCKNln1t0/fKx/SCe94OH795eL5Lfa+Nn1+J+Lj7ehZ6gy3zpG OLJ4Qv6mjQm6sLq0vEYlsRVMYvB7xp7X6G74y1NQgyaFHoXeRR3pNmFSfJK5mJvXcij9 92MZUnJqOstODkwyhg9NA9hC4EHkOnZtX0uGftovs4WKe++q950nzDQEq3E9bpAhocyH znmndCfttp+xFyqLHbGhIvp0K9frH0qnHZpE0s5JUIvOlUORaNTbO/FyJpzU947Kbkkr B/R+RhJWNDMsrOhzNAzFgyU8cfdEB1unkN/XgFKj68j19zz7KrnYAuBSzhN0K2NbMgTd ttRg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1678246081; 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=ZJj61gxvsnAstCshIubsPwP+A0RbNepTL+cBruG18fI=; b=r0VHGiQ7HBu6JXz26tQ2LKunhAjRaly7vBDCsZKivTiU7Ft9yRbnbVjTKlN9XiN9q/ C7Q4jLyCeFldhOIc5EZv+/nW5p3TRqONnnWeVQZ7mKO+8MpXi5HYyt2+B9nGjAy/O+bO nrAVk6B/opprkqQePw36Up3nG++7aqpZUXZnGmwfoUAzVmZecQiJ23ePG2xVG0bAin5g EILMRgvKhnF7J+iklmkdfB5+SMpnv0vuf6S4uR69XY9DwcDhSr502NuJ8P2mXI2shERJ a0dRuLP72epiuT32DR0m9CwFIbBQgBIN/nIbh+U/W7i+ywStUU/oP4634FKniHGCAb3B 4+pg== X-Gm-Message-State: AO0yUKVB7S529a+btnGl5RplQa7cNMzdeEEGyXxEzb4agavwCGyMZa3D Hemtavopzh04+mmpNtue31Lqc0y0qOJHVXtL X-Received: by 2002:a17:902:a416:b0:19e:b5d3:170f with SMTP id p22-20020a170902a41600b0019eb5d3170fmr9392693plq.4.1678246080761; Tue, 07 Mar 2023 19:28:00 -0800 (PST) Received: from localhost ([113.161.42.54]) by smtp.gmail.com with ESMTPSA id y8-20020a170902700800b001993a1fce7bsm8966354plk.196.2023.03.07.19.28.00 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 07 Mar 2023 19:28: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, arnd@arndb.de, linux-api@vger.kernel.org, kernel-team@meta.com Subject: [PATCH v11 3/3] selftests: Add selftests for cachestat Date: Tue, 7 Mar 2023 19:27:48 -0800 Message-Id: <20230308032748.609510-4-nphamcs@gmail.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230308032748.609510-1-nphamcs@gmail.com> References: <20230308032748.609510-1-nphamcs@gmail.com> MIME-Version: 1.0 X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1759769463192109394?= X-GMAIL-MSGID: =?utf-8?q?1759769463192109394?= 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 | 257 ++++++++++++++++++ 5 files changed, 275 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 -- 2.39.2 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..f62ffb30f8ca --- /dev/null +++ b/tools/testing/selftests/cachestat/test_cachestat.c @@ -0,0 +1,257 @@ +// 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; + +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"); + ret = false; + 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, filesize, 0, &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, filesize, 0, &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, compute_len, off, &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; +}