Message ID | 20230123173748.1734238-11-shr@devkernel.io |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:adf:eb09:0:0:0:0:0 with SMTP id s9csp1743309wrn; Mon, 23 Jan 2023 10:05:31 -0800 (PST) X-Google-Smtp-Source: AMrXdXvDDo+auUtjhm5kiubPo5iUf+idrYyvDlZ6Us6bolK4XPbBaGx/zieIeA0bfflCon8lgzzr X-Received: by 2002:aa7:c9c7:0:b0:499:cc32:6a52 with SMTP id i7-20020aa7c9c7000000b00499cc326a52mr37935386edt.16.1674497131613; Mon, 23 Jan 2023 10:05:31 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1674497131; cv=none; d=google.com; s=arc-20160816; b=wct7r0k8iDXPellzavZUUEVRLgtufXSQ+D4/TBIoHjp7/dC1a68KJfHQU/uz12syXq OjfGSSH8VeHwMhSIPjzZaySOE8UxSwl64o/Im8wUE2WT/H18I5+Ss3DfbizkUfImTo5y sill9fn9isY+g2vkuVn9rnQzp9pgxDaWt7fGwUTrUMIqOESV9m1mxHxzRJMB3riwJNUZ TBrFXQ/nxbO4N6jRCUsvwJRD5NUliMSYfLV74PT4Y5wqjrvpB0oY0zvEOk2IuHinlomS picCmg9fhWA+PlEF8X2fWi8Q67YjR+NGB4yUqX0vMzhtx5aHb6I6NbDecqiA0PPViaSL elxg== 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; bh=CA0SVXvV73URjako0cuzE5C6ugRhDCRksA+GC3YJ0zQ=; b=G94YeYLpE+OPzfNtFSUfGSCkfJAdIHsWopQxyAmLuJg6Mw4k6Jb36i6udQs3xoh9hS kKCpQxxvbVe2WBr7/spdijLBS7ir7osXg60CTpuVmbzDK9ssPvGjAaKrw9o1PrEYivuC 5hiMIZ5h9eMUDYeYIWgsw89Ek1i+9aFQ99emqpER+kQKZYL5mxBGYca8ywLn4NGdm4CP 3NVVFRljMk49i070UnNA0SRzDT9lmipWOVrUfv5Fw/tjgAxISbspExlQLE1im/z+pCwL h92KZCEPdZwdYWM4SZeRlVv94PQ7APTXVDigjNe7iXgvYta/ZiOKuOOmktqqUhSCWXf/ 764g== ARC-Authentication-Results: i=1; mx.google.com; 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 Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id p26-20020a056402501a00b0049e16834b77si1650eda.346.2023.01.23.10.05.07; Mon, 23 Jan 2023 10:05:31 -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; 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 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233293AbjAWSBu (ORCPT <rfc822;rust.linux@gmail.com> + 99 others); Mon, 23 Jan 2023 13:01:50 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:39984 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233077AbjAWSBt (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Mon, 23 Jan 2023 13:01:49 -0500 Received: from 66-220-144-178.mail-mxout.facebook.com (66-220-144-178.mail-mxout.facebook.com [66.220.144.178]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id F21C444BD for <linux-kernel@vger.kernel.org>; Mon, 23 Jan 2023 10:01:47 -0800 (PST) Received: by dev0134.prn3.facebook.com (Postfix, from userid 425415) id 67ABE5616BE5; Mon, 23 Jan 2023 09:37:56 -0800 (PST) From: Stefan Roesch <shr@devkernel.io> To: linux-mm@kvack.org Cc: shr@devkernel.io, linux-doc@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org, linux-trace-kernel@vger.kernel.org Subject: [RESEND RFC PATCH v1 10/20] docs: document general_profit sysfs knob Date: Mon, 23 Jan 2023 09:37:38 -0800 Message-Id: <20230123173748.1734238-11-shr@devkernel.io> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230123173748.1734238-1-shr@devkernel.io> References: <20230123173748.1734238-1-shr@devkernel.io> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Spam-Status: No, score=2.4 required=5.0 tests=BAYES_00,RDNS_DYNAMIC, SPF_HELO_PASS,SPF_NEUTRAL,SUSPICIOUS_RECIPS,TVD_RCVD_IP autolearn=no autolearn_force=no version=3.4.6 X-Spam-Level: ** X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: <linux-kernel.vger.kernel.org> X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1755837504244463334?= X-GMAIL-MSGID: =?utf-8?q?1755837504244463334?= |
Series |
mm: process/cgroup ksm support
|
|
Commit Message
Stefan Roesch
Jan. 23, 2023, 5:37 p.m. UTC
This adds documentation for the new /sys/kernel/mm/ksm/general_profit
knob.
Signed-off-by: Stefan Roesch <shr@devkernel.io>
---
Documentation/ABI/testing/sysfs-kernel-mm-ksm | 8 ++++++++
Documentation/admin-guide/mm/ksm.rst | 2 ++
2 files changed, 10 insertions(+)
Comments
On Mon, Jan 23, 2023 at 09:37:38AM -0800, Stefan Roesch wrote: > This adds documentation for the new /sys/kernel/mm/ksm/general_profit > knob. "Document general_profit knob." > > Signed-off-by: Stefan Roesch <shr@devkernel.io> > --- > Documentation/ABI/testing/sysfs-kernel-mm-ksm | 8 ++++++++ > Documentation/admin-guide/mm/ksm.rst | 2 ++ > 2 files changed, 10 insertions(+) > > diff --git a/Documentation/ABI/testing/sysfs-kernel-mm-ksm b/Documentation/ABI/testing/sysfs-kernel-mm-ksm > index d244674a9480..7768e90f7a8f 100644 > --- a/Documentation/ABI/testing/sysfs-kernel-mm-ksm > +++ b/Documentation/ABI/testing/sysfs-kernel-mm-ksm > @@ -51,3 +51,11 @@ Description: Control merging pages across different NUMA nodes. > > When it is set to 0 only pages from the same node are merged, > otherwise pages from all nodes can be merged together (default). > + > +What: /sys/kernel/mm/ksm/general_profit > +Date: January 2023 > +KernelVersion: 6.1 > +Contact: Linux memory management mailing list <linux-mm@kvack.org> > +Description: Measure how effective KSM is. > + general_profit: how effective is KSM. The formula for the > + calculation is in Documentation/admin-guide/mm/ksm.rst. > diff --git a/Documentation/admin-guide/mm/ksm.rst b/Documentation/admin-guide/mm/ksm.rst > index fb6ba2002a4b..72189bf1283e 100644 > --- a/Documentation/admin-guide/mm/ksm.rst > +++ b/Documentation/admin-guide/mm/ksm.rst > @@ -159,6 +159,8 @@ stable_node_chains_prune_millisecs > > The effectiveness of KSM and MADV_MERGEABLE is shown in ``/sys/kernel/mm/ksm/``: > > +general_profit > + how effective is KSM. The calculation is explained below. > pages_shared > how many shared pages are being used > pages_sharing Seems like the wording is confusing me, so I write the improv: ---- >8 ---- diff --git a/Documentation/ABI/testing/sysfs-kernel-mm-ksm b/Documentation/ABI/testing/sysfs-kernel-mm-ksm index 7768e90f7a8fef..5309a912ab679b 100644 --- a/Documentation/ABI/testing/sysfs-kernel-mm-ksm +++ b/Documentation/ABI/testing/sysfs-kernel-mm-ksm @@ -56,6 +56,6 @@ What: /sys/kernel/mm/ksm/general_profit Date: January 2023 KernelVersion: 6.1 Contact: Linux memory management mailing list <linux-mm@kvack.org> -Description: Measure how effective KSM is. - general_profit: how effective is KSM. The formula for the - calculation is in Documentation/admin-guide/mm/ksm.rst. +Description: Measure the KSM profit. See + :ref:`KSM documentation <monitoring-ksm-profit>` for details + on the calculated formula. diff --git a/Documentation/admin-guide/mm/ksm.rst b/Documentation/admin-guide/mm/ksm.rst index 70896f01d64106..fb67318aab1ba2 100644 --- a/Documentation/admin-guide/mm/ksm.rst +++ b/Documentation/admin-guide/mm/ksm.rst @@ -160,7 +160,8 @@ stable_node_chains_prune_millisecs The effectiveness of KSM and MADV_MERGEABLE is shown in ``/sys/kernel/mm/ksm/``: general_profit - how effective is KSM. The calculation is explained below. + the KSM profit. The calculation is described :ref:`below + <monitoring-ksm-profit>`. pages_shared how many shared pages are being used pages_sharing @@ -186,6 +187,8 @@ The maximum possible ``pages_sharing/pages_shared`` ratio is limited by the ``max_page_sharing`` tunable. To increase the ratio ``max_page_sharing`` must be increased accordingly. +.. _monitoring-ksm-profit: + Monitoring KSM profit ===================== Thanks.
Bagas Sanjaya <bagasdotme@gmail.com> writes: > Seems like the wording is confusing me, so I write the improv: > > ---- >8 ---- > diff --git a/Documentation/ABI/testing/sysfs-kernel-mm-ksm b/Documentation/ABI/testing/sysfs-kernel-mm-ksm > index 7768e90f7a8fef..5309a912ab679b 100644 > --- a/Documentation/ABI/testing/sysfs-kernel-mm-ksm > +++ b/Documentation/ABI/testing/sysfs-kernel-mm-ksm > @@ -56,6 +56,6 @@ What: /sys/kernel/mm/ksm/general_profit > Date: January 2023 > KernelVersion: 6.1 > Contact: Linux memory management mailing list <linux-mm@kvack.org> > -Description: Measure how effective KSM is. > - general_profit: how effective is KSM. The formula for the > - calculation is in Documentation/admin-guide/mm/ksm.rst. > +Description: Measure the KSM profit. See > + :ref:`KSM documentation <monitoring-ksm-profit>` for details > + on the calculated formula. So the original at least attempted to tell us what "KSM profit" is; the "improved" version makes no such effort. I don't think that is actually better. jon
On Tue, Jan 24, 2023 at 09:21:51AM -0700, Jonathan Corbet wrote: > Bagas Sanjaya <bagasdotme@gmail.com> writes: > > > Seems like the wording is confusing me, so I write the improv: > > > > ---- >8 ---- > > diff --git a/Documentation/ABI/testing/sysfs-kernel-mm-ksm b/Documentation/ABI/testing/sysfs-kernel-mm-ksm > > index 7768e90f7a8fef..5309a912ab679b 100644 > > --- a/Documentation/ABI/testing/sysfs-kernel-mm-ksm > > +++ b/Documentation/ABI/testing/sysfs-kernel-mm-ksm > > @@ -56,6 +56,6 @@ What: /sys/kernel/mm/ksm/general_profit > > Date: January 2023 > > KernelVersion: 6.1 > > Contact: Linux memory management mailing list <linux-mm@kvack.org> > > -Description: Measure how effective KSM is. > > - general_profit: how effective is KSM. The formula for the > > - calculation is in Documentation/admin-guide/mm/ksm.rst. > > +Description: Measure the KSM profit. See > > + :ref:`KSM documentation <monitoring-ksm-profit>` for details > > + on the calculated formula. > > So the original at least attempted to tell us what "KSM profit" is; the > "improved" version makes no such effort. I don't think that is actually > better. I overlooked that, thanks!
diff --git a/Documentation/ABI/testing/sysfs-kernel-mm-ksm b/Documentation/ABI/testing/sysfs-kernel-mm-ksm index d244674a9480..7768e90f7a8f 100644 --- a/Documentation/ABI/testing/sysfs-kernel-mm-ksm +++ b/Documentation/ABI/testing/sysfs-kernel-mm-ksm @@ -51,3 +51,11 @@ Description: Control merging pages across different NUMA nodes. When it is set to 0 only pages from the same node are merged, otherwise pages from all nodes can be merged together (default). + +What: /sys/kernel/mm/ksm/general_profit +Date: January 2023 +KernelVersion: 6.1 +Contact: Linux memory management mailing list <linux-mm@kvack.org> +Description: Measure how effective KSM is. + general_profit: how effective is KSM. The formula for the + calculation is in Documentation/admin-guide/mm/ksm.rst. diff --git a/Documentation/admin-guide/mm/ksm.rst b/Documentation/admin-guide/mm/ksm.rst index fb6ba2002a4b..72189bf1283e 100644 --- a/Documentation/admin-guide/mm/ksm.rst +++ b/Documentation/admin-guide/mm/ksm.rst @@ -159,6 +159,8 @@ stable_node_chains_prune_millisecs The effectiveness of KSM and MADV_MERGEABLE is shown in ``/sys/kernel/mm/ksm/``: +general_profit + how effective is KSM. The calculation is explained below. pages_shared how many shared pages are being used pages_sharing