From mboxrd@z Thu Jan 1 00:00:00 1970 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 57638C433EF for ; Thu, 26 May 2022 20:35:30 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id DB4778D0003; Thu, 26 May 2022 16:35:29 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id D603E8D0002; Thu, 26 May 2022 16:35:29 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id C29118D0003; Thu, 26 May 2022 16:35:29 -0400 (EDT) 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 B0E928D0002 for ; Thu, 26 May 2022 16:35:29 -0400 (EDT) Received: from smtpin22.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay13.hostedemail.com (Postfix) with ESMTP id 7DABA60633 for ; Thu, 26 May 2022 20:35:29 +0000 (UTC) X-FDA: 79509049578.22.04E2C6B Received: from out1.migadu.com (out1.migadu.com [91.121.223.63]) by imf01.hostedemail.com (Postfix) with ESMTP id 7B52E40045 for ; Thu, 26 May 2022 20:35:24 +0000 (UTC) Date: Thu, 26 May 2022 13:35:20 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.dev; s=key1; t=1653597326; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=qtEaIxsw5G8XbzZIdfhwIUxQJQ2YrDlSK/U8opLS5VE=; b=uJmYv7HWNHzyySdL3Ivc7VcwtzGR77/g/JslvuNg6Kjyo8jmBw/xmbL/rilyPqWHd7qihF u31SUyLUZ67z01O6iul5OQokizMSNpy7CjROd5lMbm+Xd5EypugvQAxfvaD8pg7eKQiWgY KTIv1nPHYAM9BE8qCSThUxGyYqN9C24= X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. From: Roman Gushchin To: Muchun Song Cc: Andrew Morton , linux-mm@kvack.org, Dave Chinner , linux-kernel@vger.kernel.org, Kent Overstreet , Hillf Danton , Christophe JAILLET Subject: Re: [PATCH v4 4/6] mm: docs: document shrinker debugfs Message-ID: References: <20220525202600.2910982-1-roman.gushchin@linux.dev> <20220525202600.2910982-5-roman.gushchin@linux.dev> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: X-Migadu-Flow: FLOW_OUT X-Migadu-Auth-User: linux.dev X-Stat-Signature: zihorioxn1b9xpa3pst7r8bam3ab1358 X-Rspam-User: Authentication-Results: imf01.hostedemail.com; dkim=pass header.d=linux.dev header.s=key1 header.b=uJmYv7HW; dmarc=pass (policy=none) header.from=linux.dev; spf=pass (imf01.hostedemail.com: domain of roman.gushchin@linux.dev designates 91.121.223.63 as permitted sender) smtp.mailfrom=roman.gushchin@linux.dev X-Rspamd-Server: rspam04 X-Rspamd-Queue-Id: 7B52E40045 X-HE-Tag: 1653597324-440771 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: On Thu, May 26, 2022 at 10:25:47AM +0800, Muchun Song wrote: > On Wed, May 25, 2022 at 01:25:58PM -0700, Roman Gushchin wrote: > > Add a document describing the shrinker debugfs interface. > > > > Signed-off-by: Roman Gushchin > > --- > > Documentation/admin-guide/mm/index.rst | 1 + > > .../admin-guide/mm/shrinker_debugfs.rst | 100 ++++++++++++++++++ > > 2 files changed, 101 insertions(+) > > create mode 100644 Documentation/admin-guide/mm/shrinker_debugfs.rst > > > > diff --git a/Documentation/admin-guide/mm/index.rst b/Documentation/admin-guide/mm/index.rst > > index c21b5823f126..1bd11118dfb1 100644 > > --- a/Documentation/admin-guide/mm/index.rst > > +++ b/Documentation/admin-guide/mm/index.rst > > @@ -36,6 +36,7 @@ the Linux memory management. > > numa_memory_policy > > numaperf > > pagemap > > + shrinker_debugfs > > soft-dirty > > swap_numa > > transhuge > > diff --git a/Documentation/admin-guide/mm/shrinker_debugfs.rst b/Documentation/admin-guide/mm/shrinker_debugfs.rst > > new file mode 100644 > > index 000000000000..2033d696aa59 > > --- /dev/null > > +++ b/Documentation/admin-guide/mm/shrinker_debugfs.rst > > @@ -0,0 +1,100 @@ > > +.. _shrinker_debugfs: > > + > > +========================== > > +Shrinker Debugfs Interface > > +========================== > > + > > +Shrinker debugfs interface provides a visibility into the kernel memory > > +shrinkers subsystem and allows to get information about individual shrinkers. > > + > > +For each shrinker registered in the system a directory in **/shrinker/** > > +is created. The directory's name is composed from the shrinker's name and an > > +unique id: e.g. *kfree_rcu-0* or *sb-xfs:vda1-36*. > > + > > +Each shrinker directory contains the **count** file, which allows to trigger > > +the *count_objects()* callback for each memcg and numa node (if applicable). > > + > > +Usage: > > +------ > > + > > +1. *List registered shrinkers* > > + > > + :: > > + > > + $ cd /sys/kernel/debug/shrinker/ > > + $ ls > > + dqcache-16 sb-hugetlbfs-17 sb-rootfs-2 sb-tmpfs-49 > > + kfree_rcu-0 sb-hugetlbfs-33 sb-securityfs-6 sb-tracefs-13 > > + sb-aio-20 sb-iomem-12 sb-selinuxfs-22 sb-xfs:vda1-36 > > + sb-anon_inodefs-15 sb-mqueue-21 sb-sockfs-8 sb-zsmalloc-19 > > + sb-bdev-3 sb-nsfs-4 sb-sysfs-26 shadow-18 > > + sb-bpf-32 sb-pipefs-14 sb-tmpfs-1 thp_deferred_split-10 > > + sb-btrfs:vda2-24 sb-proc-25 sb-tmpfs-27 thp_zero-9 > > + sb-cgroup2-30 sb-proc-39 sb-tmpfs-29 xfs_buf-vda1-37 > > + sb-configfs-23 sb-proc-41 sb-tmpfs-35 xfs_inodegc-vda1-38 > > + sb-dax-11 sb-proc-45 sb-tmpfs-40 zspool-zram0-34 > > + sb-debugfs-7 sb-proc-46 sb-tmpfs-42 > > + sb-devpts-28 sb-proc-47 sb-tmpfs-43 > > + sb-devtmpfs-5 sb-pstore-31 sb-tmpfs-44 > > + > > +2. *Get information about a specific shrinker* > > + > > + :: > > + > > + $ cd sb-btrfs\:vda2-24/ > > + $ ls > > + count > > + > > +3. *Count objects* > > + > > + Each line in the output has the following format:: > > + > > + ... > > + ... > > + ... > > + > > + If there are no objects on all numa nodes, a line is omitted. If there > > + are no objects at all, the output might be empty. > > Should we add the following lines into here? > > " > If the shrinker is not memcg-aware or CONFIG_MEMCG is off, 0 is > printed as cgroup inode id. If the shrinker is not numa-aware, 0's are > printed for all nodes except the first one. > " Yes, it sounds like a great addition. I hope Andrew can merge this in if there will be no v5. Or I'll add it by myself otherwise. Thanks! And thank you for reviewing the patches!