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 X-Spam-Level: X-Spam-Status: No, score=-15.8 required=3.0 tests=BAYES_00,DKIM_ADSP_ALL, DKIM_INVALID,DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id B90C2C433DB for ; Wed, 24 Feb 2021 07:50:51 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 0FC5264EEA for ; Wed, 24 Feb 2021 07:50:51 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 0FC5264EEA Authentication-Results: mail.kernel.org; dmarc=fail (p=quarantine dis=none) header.from=amazon.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id 5D8976B006E; Wed, 24 Feb 2021 02:50:50 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 589186B0070; Wed, 24 Feb 2021 02:50:50 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 478106B0071; Wed, 24 Feb 2021 02:50:50 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0089.hostedemail.com [216.40.44.89]) by kanga.kvack.org (Postfix) with ESMTP id 30D246B006E for ; Wed, 24 Feb 2021 02:50:50 -0500 (EST) Received: from smtpin11.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay05.hostedemail.com (Postfix) with ESMTP id E08B91802BDF7 for ; Wed, 24 Feb 2021 07:50:49 +0000 (UTC) X-FDA: 77852389818.11.3F3C841 Received: from smtp-fw-4101.amazon.com (smtp-fw-4101.amazon.com [72.21.198.25]) by imf16.hostedemail.com (Postfix) with ESMTP id BACA880192E2 for ; Wed, 24 Feb 2021 07:50:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amazon.com; i=@amazon.com; q=dns/txt; s=amazon201209; t=1614153049; x=1645689049; h=from:to:cc:subject:date:message-id:mime-version: in-reply-to:content-transfer-encoding; bh=DXdAXbodLJFLCACHgM3UuUQ3p+oQUqas3URxarIcAkE=; b=Es5GCC3XX7Vyo+svowUNPylKAYFKNwyZQmM+xPHE0r738Yix9jFJ057L NrGo9alLfX9nGQu4pIxMvBsZ5CTzJksdHwqe+hNgqTIzasfyWEY/6zrru D8+7cplI0nuQ3wdN6vfatFKpEt1CpdCgS2AvY6Enc4Qlqy9qNAbLkW+BM I=; X-IronPort-AV: E=Sophos;i="5.81,202,1610409600"; d="scan'208";a="87490840" Received: from iad12-co-svc-p1-lb1-vlan2.amazon.com (HELO email-inbound-relay-2b-81e76b79.us-west-2.amazon.com) ([10.43.8.2]) by smtp-border-fw-out-4101.iad4.amazon.com with ESMTP; 24 Feb 2021 07:50:35 +0000 Received: from EX13D31EUA001.ant.amazon.com (pdx1-ws-svc-p6-lb9-vlan3.pdx.amazon.com [10.236.137.198]) by email-inbound-relay-2b-81e76b79.us-west-2.amazon.com (Postfix) with ESMTPS id 8B170A1C18; Wed, 24 Feb 2021 07:50:32 +0000 (UTC) Received: from u3f2cd687b01c55.ant.amazon.com (10.43.162.228) by EX13D31EUA001.ant.amazon.com (10.43.165.15) with Microsoft SMTP Server (TLS) id 15.0.1497.2; Wed, 24 Feb 2021 07:50:14 +0000 From: SeongJae Park To: SeongJae Park CC: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , Subject: Re: [PATCH v24 11/14] Documentation: Add documents for DAMON Date: Wed, 24 Feb 2021 08:49:55 +0100 Message-ID: <20210224074955.20173-1-sjpark@amazon.com> X-Mailer: git-send-email 2.17.1 MIME-Version: 1.0 In-Reply-To: <20210204153150.15948-12-sjpark@amazon.com> Content-Type: text/plain; charset="UTF-8" X-Originating-IP: [10.43.162.228] X-ClientProxiedBy: EX13D21UWA003.ant.amazon.com (10.43.160.184) To EX13D31EUA001.ant.amazon.com (10.43.165.15) X-Stat-Signature: efazknqkbqsofddf77r4uienfmjfszmq X-Rspamd-Server: rspam05 X-Rspamd-Queue-Id: BACA880192E2 Received-SPF: none (amazon.com>: No applicable sender policy available) receiver=imf16; identity=mailfrom; envelope-from=""; helo=smtp-fw-4101.amazon.com; client-ip=72.21.198.25 X-HE-DKIM-Result: pass/pass X-HE-Tag: 1614153048-273712 Content-Transfer-Encoding: quoted-printable 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, 4 Feb 2021 16:31:47 +0100 SeongJae Park wrote= : > From: SeongJae Park >=20 > This commit adds documents for DAMON under > `Documentation/admin-guide/mm/damon/` and `Documentation/vm/damon/`. >=20 > Signed-off-by: SeongJae Park > --- > Documentation/admin-guide/mm/damon/guide.rst | 159 ++++++++++ > Documentation/admin-guide/mm/damon/index.rst | 15 + > Documentation/admin-guide/mm/damon/plans.rst | 29 ++ > Documentation/admin-guide/mm/damon/start.rst | 97 ++++++ > Documentation/admin-guide/mm/damon/usage.rst | 304 +++++++++++++++++++ > Documentation/admin-guide/mm/index.rst | 1 + > Documentation/vm/damon/api.rst | 20 ++ > Documentation/vm/damon/design.rst | 166 ++++++++++ > Documentation/vm/damon/eval.rst | 232 ++++++++++++++ > Documentation/vm/damon/faq.rst | 58 ++++ > Documentation/vm/damon/index.rst | 31 ++ > Documentation/vm/index.rst | 1 + > 12 files changed, 1113 insertions(+) > create mode 100644 Documentation/admin-guide/mm/damon/guide.rst > create mode 100644 Documentation/admin-guide/mm/damon/index.rst > create mode 100644 Documentation/admin-guide/mm/damon/plans.rst > create mode 100644 Documentation/admin-guide/mm/damon/start.rst > create mode 100644 Documentation/admin-guide/mm/damon/usage.rst > create mode 100644 Documentation/vm/damon/api.rst > create mode 100644 Documentation/vm/damon/design.rst > create mode 100644 Documentation/vm/damon/eval.rst > create mode 100644 Documentation/vm/damon/faq.rst > create mode 100644 Documentation/vm/damon/index.rst >=20 [...] > diff --git a/Documentation/admin-guide/mm/damon/usage.rst b/Documentati= on/admin-guide/mm/damon/usage.rst > new file mode 100644 > index 000000000000..32436cf853c7 > --- /dev/null > +++ b/Documentation/admin-guide/mm/damon/usage.rst > @@ -0,0 +1,304 @@ > +.. SPDX-License-Identifier: GPL-2.0 > + > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > +Detailed Usages > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > + > +DAMON provides below three interfaces for different users. > + > +- *DAMON user space tool.* > + This is for privileged people such as system administrators who want= a > + just-working human-friendly interface. Using this, users can use th= e DAMON=C3=A2=E2=82=AC=E2=84=A2s > + major features in a human-friendly way. It may not be highly tuned = for > + special cases, though. It supports only virtual address spaces moni= toring. > +- *debugfs interface.* > + This is for privileged user space programmers who want more optimize= d use of > + DAMON. Using this, users can use DAMON=C3=A2=E2=82=AC=E2=84=A2s maj= or features by reading > + from and writing to special debugfs files. Therefore, you can write= and use > + your personalized DAMON debugfs wrapper programs that reads/writes t= he > + debugfs files instead of you. The DAMON user space tool is also a r= eference > + implementation of such programs. It supports only virtual address s= paces > + monitoring. > +- *Kernel Space Programming Interface.* > + This is for kernel space programmers. Using this, users can utilize= every > + feature of DAMON most flexibly and efficiently by writing kernel spa= ce > + DAMON application programs for you. You can even extend DAMON for v= arious > + address spaces. > + > +This document does not describe the kernel space programming interface= in > +detail. For that, please refer to the :doc:`/vm/damon/api`. > + > + > +DAMON User Space Tool > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D This version of the patchset doesn't introduce the user space tool source= code, so putting the detailed usage here might make no sense. I will remove th= is section in the next version. If you will review this patch, please skip = this section. [...] > + > +debugfs Interface > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D But, this section will not be removed. Please review. [...] Thanks, SeongJae Park