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 D6E7EC7EE29 for ; Thu, 25 May 2023 21:43:44 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id E772890000A; Thu, 25 May 2023 17:43:30 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id E188C900009; Thu, 25 May 2023 17:43:30 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id C958D90000A; Thu, 25 May 2023 17:43:30 -0400 (EDT) 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 AF4FA900006 for ; Thu, 25 May 2023 17:43:30 -0400 (EDT) Received: from smtpin28.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay04.hostedemail.com (Postfix) with ESMTP id 8843D1A0671 for ; Thu, 25 May 2023 21:43:30 +0000 (UTC) X-FDA: 80830104180.28.EF2238A Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by imf15.hostedemail.com (Postfix) with ESMTP id F35D8A0008 for ; Thu, 25 May 2023 21:43:28 +0000 (UTC) Authentication-Results: imf15.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=nUwAJi3+; spf=pass (imf15.hostedemail.com: domain of sj@kernel.org designates 139.178.84.217 as permitted sender) smtp.mailfrom=sj@kernel.org; dmarc=pass (policy=none) header.from=kernel.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1685051009; 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=EHFw/0bbYxWESWQzXcxnUDPytC/XadxJBBIMogJ9w8Q=; b=2pxN2TXIajbkmWqTf50cHVKn+47l0Zez5gE6flwflUi07wXkw6x8quAm91vPunpF1cSmPM Qb/zd2HYNqsB0b/kBxLq7K+u4cSMTEhICyn8xfUTk4NZMTN7sR1JIlYVo8lbKQZM1M6OUb OHQG1RV1tXUjnCvqWuqEK1aSj1Krf+4= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1685051009; a=rsa-sha256; cv=none; b=gzQdof78tbHfHoEalIbwQEnvcQtrJV9BRbG879PNalka484z0JqS45SF0W1RYRRDjp2WA7 kwqu1XIUs8I28WUvFxIDdOz17bEkkY/mHNY0Y4pgSjDe1BlbdvvS4yFm+UgX6Uk/kgOzND /uJ5Ui1IEH6rr3CFFakCLz8PfCNBvSQ= ARC-Authentication-Results: i=1; imf15.hostedemail.com; dkim=pass header.d=kernel.org header.s=k20201202 header.b=nUwAJi3+; spf=pass (imf15.hostedemail.com: domain of sj@kernel.org designates 139.178.84.217 as permitted sender) smtp.mailfrom=sj@kernel.org; dmarc=pass (policy=none) header.from=kernel.org Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dfw.source.kernel.org (Postfix) with ESMTPS id AB38264B74; Thu, 25 May 2023 21:43:28 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 1FD41C4339C; Thu, 25 May 2023 21:43:27 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1685051007; bh=ZSCtM5xpPfxl9ZcGY7kbIAlY3W8XFj4VJBVoZq5mrJw=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=nUwAJi3+gowT9HAFkMA0ZZUXqK2ioGmXpGUdjFB/arrg1Po32AkJnMJW3vr1F8fVE qRIBYNlqXONIP0Ej+C7cc/MCaVrcckNuW4yEzQ7sIBvgdjWCbVpn/lCXKn9b9fu0oI dnlfRUcIp1zYYpGfvXXb55umKr+yvpGgN6M8KjTixK6MXezkXnfeA8fDKIZecHpPWf LGfcobjbi87gaaplEvo3xfU+sQkC+jAp+vvInameYiGl+KrtIbhVILbRJUl+1HcQeX 7mgDcXYZqiVLlOp1U/byyRYiOev/QYdoYXqSwsMA4SMhMeCfWNDbss1MhsUNGpdt+1 8LcZKj9Jmx1eA== From: SeongJae Park To: Andrew Morton Cc: SeongJae Park , Jonathan Corbet , damon@lists.linux.dev, linux-mm@kvack.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH 09/10] Docs/mm/damon/design: add a section for DAMON core API Date: Thu, 25 May 2023 21:43:13 +0000 Message-Id: <20230525214314.5204-10-sj@kernel.org> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20230525214314.5204-1-sj@kernel.org> References: <20230525214314.5204-1-sj@kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Stat-Signature: 51wwye8ff1f59eh4h5xqc3qn8d7pbxun X-Rspamd-Server: rspam10 X-Rspamd-Queue-Id: F35D8A0008 X-Rspam-User: X-HE-Tag: 1685051008-196890 X-HE-Meta: U2FsdGVkX19LuFhrwCKKMA1fU53eP6YOKvWi11tUMVqNo/i9MUc/L0v0+j/Ozj0scNRjuqXcljgoai01ls/nteGjDX/h/PG45X3uugb+cvIOkWfbHSA9FPuPAWJU3l9SPrQGAnDdsjeTGCN5yA1M5aTjf3gmIbynvLPadAEDFysIZ7eftMKHlfoSj36ocN6gaD6mFmjVnHtF/jEv49GkT5/uEj4UJBXeIujzveDU+pUm/qEvNEUje4HOZkh+Bp/aZp7HrgoFLJUvtIFa/l3D7kywd1GylzSZLHA8i44OsE8jK7GIdTzZWlqr7bSGWpEuG5dX7gUW8ldGq3flAHTMvKjXiybGqxBEebijmg7Ymn+lq5L9cjS/z+7+hcxRXQXe/vqUzfXn/p8/BynpT+XG//WOnuMilfE/q6lTARZzwyB2Hni1TlgA/jZO4D7EaoqMSDviIuw+6rfwXqEs+qohyRVD5Y2pNVe/j4M++NwATYicpey941AYWMfnkXwKml/I5IEnbEaEC2g/y0fV9W0oUM/UBvJC0mJu2qNf9/Z5Vqx7Hh2W0BGpXEco4Ns0Vk3hdI9qBW3vW+8TqYGHtuApBTN3vuLx9yNYMVfsKJyVU44CG+wSYtTKivUIsMdzyJRPT/oHOhwZmP07TIM4yRZNEkl8TUJfzEX64C9o8q4lqqzaZ+IRMiEkpZ3Hdm+xwJRy5wLyOFJPl3sUierRjM8GqTE0gnjLNWKVb1awKvcZw8otAa7UB24OZTQD6vrvRXLTrVi3WuClvGNEiC5bQ8fWf0/VjzwEj8yekHNNI6YUiB4JxG64hE3LmaHNeKYhT0PvqXwnfcJc6HMRAbhfb6yNIk3GVouO71jpA37JGj+qBAz+pmjsBSWjVQjKTqinxKjcJ0hc+Bkj8n9hR1FP8X85lnz7im0z/It9hvrUtBLnYPyyeN/dG+mxxsEzIjdFHAd7aNiAk0VPnNNXlXxAUd/ GAHIADF+ +mKGAkGcVatJs1LnC90yJ5Xwx34HjaBcK5rmC1OC8rzfYnOYK/wnY/OpFNDrDtaawI7quIWP74pOsygRzvmhW3uk3B/YPoWYgJRsIyGGrbFirI8jD+Mhnq8veX5qegKFVJbFOQN1eznsVgDijTZrxNioLy2wd2z24+XdUDkMKZVOkstxzcEdNmNUP1gQTgm0c8ugQqqIalzvmdzKzNLj4MfYSK/YZdoHgtgnVSUGaGmCoMfDzcNHsKKqBxNVlqusET+dzx0MxoXhahpuZG5sdr6ZzSLsXdPOnMhcn8vH72IC4Hl/oNl984jSK60sChaZyCHTDqM5t0/eCqyFjyJqZaeOppA== 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: Add a section covering the API of DAMON core layer on the design document. Signed-off-by: SeongJae Park --- Documentation/mm/damon/design.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/Documentation/mm/damon/design.rst b/Documentation/mm/damon/design.rst index 706dbc17c6cb..0ccdd2f6af9f 100644 --- a/Documentation/mm/damon/design.rst +++ b/Documentation/mm/damon/design.rst @@ -358,3 +358,15 @@ example, the memory cgroup filter type asks users to specify the file path of the memory cgroup for the filter. Hence, users can apply specific schemes to only anonymous pages, non-anonymous pages, pages of specific cgroups, all pages excluding those of specific cgroups, and any combination of those. + + +Application Programming Interface +--------------------------------- + +The programming interface for kernel space data access-aware applications. +DAMON is a framework, so it does nothing by itself. Instead, it only helps +other kernel components such as subsystems and modules building their data +access-aware applications using DAMON's core features. For this, DAMON exposes +its all features to other kernel components via its application programming +interface, namely ``include/linux/damon.h``. Please refer to the API +:doc:`document ` for details of the interface. -- 2.25.1