From patchwork Wed Jan 24 20:03:48 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Verma, Vishal L" X-Patchwork-Id: 13529617 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 07B13C46CD2 for ; Wed, 24 Jan 2024 20:04:34 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id E52E26B0088; Wed, 24 Jan 2024 15:04:28 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id DA84E6B0087; Wed, 24 Jan 2024 15:04:28 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id BFC626B0088; Wed, 24 Jan 2024 15:04:28 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0013.hostedemail.com [216.40.44.13]) by kanga.kvack.org (Postfix) with ESMTP id A8DEC6B0083 for ; Wed, 24 Jan 2024 15:04:28 -0500 (EST) Received: from smtpin08.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay04.hostedemail.com (Postfix) with ESMTP id 6C29C1A0415 for ; Wed, 24 Jan 2024 20:04:28 +0000 (UTC) X-FDA: 81715281816.08.31B2550 Received: from mgamail.intel.com (mgamail.intel.com [198.175.65.15]) by imf27.hostedemail.com (Postfix) with ESMTP id 4018D4000F for ; Wed, 24 Jan 2024 20:04:26 +0000 (UTC) Authentication-Results: imf27.hostedemail.com; dkim=pass header.d=intel.com header.s=Intel header.b="J/X21R3v"; dmarc=pass (policy=none) header.from=intel.com; spf=pass (imf27.hostedemail.com: domain of vishal.l.verma@intel.com designates 198.175.65.15 as permitted sender) smtp.mailfrom=vishal.l.verma@intel.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1706126666; 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-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=XUmZz8pgbOQyFoQipuzs/q5/a1ezSTUJLIhuIbBITmw=; b=gdq+C+ft+iSLmT+0xJxk7+qI5tNbng4Yhu4CmOIQnpfPwJoUocF6EfAPK2iyMTdqGQZdfl a0kax4EHKrqcMXzFb/oWEKcfbDEzOwkaOKKEeJh5PNNvdYhrRUmKE1n/fcYxIXVeP8cfHX 6OWVKNBMlILHgVBNupDH8PIJOBjTYtI= ARC-Authentication-Results: i=1; imf27.hostedemail.com; dkim=pass header.d=intel.com header.s=Intel header.b="J/X21R3v"; dmarc=pass (policy=none) header.from=intel.com; spf=pass (imf27.hostedemail.com: domain of vishal.l.verma@intel.com designates 198.175.65.15 as permitted sender) smtp.mailfrom=vishal.l.verma@intel.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1706126666; a=rsa-sha256; cv=none; b=VtHgAGE5ZGVRWN40xVbBdTwPEzbMwCGx0JK4k1MibNtJlJCuKNXBaok16bINwPmkLAd+m9 cwGpSk3xTlnsXJyI2R+M9Av0z3VP2kjTdJNM0DYvzNZcE25GzOn6HsuTWZKwq8Pgz/AAb7 f+k+c5LknCmKZ1njaX6GEKWJOJ7O9cY= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1706126666; x=1737662666; h=from:date:subject:mime-version:content-transfer-encoding: message-id:references:in-reply-to:to:cc; bh=pbx8GN6oF7bpvrPHhUbumLfrIjuzdnl/0AJX9PTq6Qc=; b=J/X21R3vINkmSZ5Gik1UNJWwHK+buzpU22mesBJr3nk3c9m2UMmlg+3Z IOEU/YAsxOhXE6UYcirv1DykOoxj8xtOU7lFdymKw00j2/saERWtzJ5vm l9wFIgx/atsY97JnKLlXte+7cZvU8aywGWTI58oX79zUc6ON+m2OpGeFj vZfHyo56nJuS/ugccIK1Y8/CgAXhdsD+3efoCo0R+OlXwCb4zIXWA1quH +dk3JSwpJ5/tYl7c4Df4UW7ImQTWqOGnLjC4X5w74grg7LYzRrbHfUV91 e5zodPBDVYCcRxNsX6LFpMxFz+u05Gdkxkehh6N9rdSAj3Zbi4PT9EizR g==; X-IronPort-AV: E=McAfee;i="6600,9927,10962"; a="1836115" X-IronPort-AV: E=Sophos;i="6.05,216,1701158400"; d="scan'208";a="1836115" Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orvoesa107.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 24 Jan 2024 12:04:24 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10962"; a="1117735135" X-IronPort-AV: E=Sophos;i="6.05,216,1701158400"; d="scan'208";a="1117735135" Received: from vverma7-mobl3.amr.corp.intel.com (HELO [10.0.0.223]) ([10.251.14.61]) by fmsmga005-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 24 Jan 2024 12:04:22 -0800 From: Vishal Verma Date: Wed, 24 Jan 2024 12:03:48 -0800 Subject: [PATCH v7 3/5] Documentatiion/ABI: Add ABI documentation for sys-bus-dax MIME-Version: 1.0 Message-Id: <20240124-vv-dax_abi-v7-3-20d16cb8d23d@intel.com> References: <20240124-vv-dax_abi-v7-0-20d16cb8d23d@intel.com> In-Reply-To: <20240124-vv-dax_abi-v7-0-20d16cb8d23d@intel.com> To: Dan Williams , Vishal Verma , Dave Jiang , Andrew Morton , Oscar Salvador Cc: linux-kernel@vger.kernel.org, nvdimm@lists.linux.dev, linux-cxl@vger.kernel.org, David Hildenbrand , Dave Hansen , Huang Ying , Greg Kroah-Hartman , Matthew Wilcox , linux-mm@kvack.org X-Mailer: b4 0.13-dev-a684c X-Developer-Signature: v=1; a=openpgp-sha256; l=5934; i=vishal.l.verma@intel.com; h=from:subject:message-id; bh=pbx8GN6oF7bpvrPHhUbumLfrIjuzdnl/0AJX9PTq6Qc=; b=owGbwMvMwCXGf25diOft7jLG02pJDKkbc505nke437328TqL7m7B7XeMf4c4z14x5ZK/0LvjS 1xWGTi97ChlYRDjYpAVU2T5u+cj4zG57fk8gQmOMHNYmUCGMHBxCsBEvtQxMmzIv34xu9h1/lQW WXGViZ17Pltryjld/3Ve88XRDX2x874y/LM8U6QgKhpdXrq7oI+tdtmOgq1avXd62RekHvr6/FK NPw8A X-Developer-Key: i=vishal.l.verma@intel.com; a=openpgp; fpr=F8682BE134C67A12332A2ED07AFA61BEA3B84DFF X-Rspam-User: X-Rspamd-Server: rspam12 X-Rspamd-Queue-Id: 4018D4000F X-Stat-Signature: xsgehc4dxmnjri3abam6nhr78ojc1gbr X-HE-Tag: 1706126666-452768 X-HE-Meta: U2FsdGVkX18uLZMDQgLGdLPNJDihEkL+ByX06G6Mup7Sdz6WN2T/9MuyBqlVxQe3bb8dJM0MXyL1EZWylvSmYMNyOnrcArLfM/eGvLcQdnNL2qXz9ure7OOiM9r/jHbYQy610ymT10HuZ8T5qAHWk+a47SaY/KwtS14THNollWO1OTo3pEzTFCRLAmdC7iRL9V7UZBF3ZOdXfTJoZuo+dlHO+kMZj+BnRbgxXX4quXz9pQCDEwKroxh8v9vxmidibwGN5bBKediUT54/ZTkICGdDvtrcFUaQaaNdHbH83yxP0d52FZ4ir/LYoC6PfTr20XiOdkCxZckpeM7tIMhuNH8tyUsg0yv7AYwIOcqLosFB7Ly+dXe53fbHMJlj0Q4wJlhblQP/JZSqPVYdBcr+b4llywIYPrvnDbaX1f2QiYPdhtQJJTzxzvAFp7g1j9c9IxYYbaZm3IBNeKnIvkvvwSA2Xxv50BvABPEZJCUlDdvcyVNLgmdPLRfvnFWZx5gYEBSuyfQ8dEVj7GFJMcEGbCKE6i2JvpxeUHj13FnbrKbAR1kSg1f07dpwnNTCXlmuyeC3pjan5dgLNFJvHjVrKJqUAQ5cY+0mN/JznMRQ53jA0fSWTRQiZXGZJ4mS7BV6fcwRoGhSvdBG07tg1nfCBuPeiEL85vQRrAeGyjD4EkwJAYB6HmX7xvDhBodz7HlWSZR13MNTc15mZKHycdncKsp5TzgMh3GMHDG9hD4X7ydVPUvIPemSKPAm6i4CEPAm62+SCFlI02Sw+GGhfAB2LtoHApFSHEe7U1J30wMfg14DfhF2T8zswAzupzIlM+dXZKIq8M4LK3+1W7SoMSBKdgqYmeCIzivVNCdjc8d2XdTcJNNmwqBPI1qaJt9YFpY3CtWbw3IMeVZUNPZHg6GkE0R6UFzDfOqjtiOJNsC+LIM5sARa1a4rIOtg7caTWfZkyBN39QboHE5uh7L8mzm 5eFhvoeW LkmpBc5IUGUNGr4jJ9xYHmE3pjEGWOpQPGWvrK29g5xtnuicgTPVnblXJtpddw4NZE/V2ZyKzeXhQAWvdOEWBmyiUd/5iU097P0sx/aYxaOoCOYktcxKLS3WLOJglpvwT+FT5iB+gFL21+16LRojNPK2g4m1VQxN+67MkQ/VGbmbiY9O//8ns4+cXKjvhE42GyoDB 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: List-Subscribe: List-Unsubscribe: Add the missing sysfs ABI documentation for the device DAX subsystem. Various ABI attributes under this have been present since v5.1, and more have been added over time. In preparation for adding a new attribute, add this file with the historical details. Cc: Dan Williams Signed-off-by: Vishal Verma --- Documentation/ABI/testing/sysfs-bus-dax | 136 ++++++++++++++++++++++++++++++++ 1 file changed, 136 insertions(+) diff --git a/Documentation/ABI/testing/sysfs-bus-dax b/Documentation/ABI/testing/sysfs-bus-dax new file mode 100644 index 000000000000..6359f7bc9bf4 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-bus-dax @@ -0,0 +1,136 @@ +What: /sys/bus/dax/devices/daxX.Y/align +Date: October, 2020 +KernelVersion: v5.10 +Contact: nvdimm@lists.linux.dev +Description: + (RW) Provides a way to specify an alignment for a dax device. + Values allowed are constrained by the physical address ranges + that back the dax device, and also by arch requirements. + +What: /sys/bus/dax/devices/daxX.Y/mapping +Date: October, 2020 +KernelVersion: v5.10 +Contact: nvdimm@lists.linux.dev +Description: + (WO) Provides a way to allocate a mapping range under a dax + device. Specified in the format -. + +What: /sys/bus/dax/devices/daxX.Y/mapping[0..N]/start +What: /sys/bus/dax/devices/daxX.Y/mapping[0..N]/end +What: /sys/bus/dax/devices/daxX.Y/mapping[0..N]/page_offset +Date: October, 2020 +KernelVersion: v5.10 +Contact: nvdimm@lists.linux.dev +Description: + (RO) A dax device may have multiple constituent discontiguous + address ranges. These are represented by the different + 'mappingX' subdirectories. The 'start' attribute indicates the + start physical address for the given range. The 'end' attribute + indicates the end physical address for the given range. The + 'page_offset' attribute indicates the offset of the current + range in the dax device. + +What: /sys/bus/dax/devices/daxX.Y/resource +Date: June, 2019 +KernelVersion: v5.3 +Contact: nvdimm@lists.linux.dev +Description: + (RO) The resource attribute indicates the starting physical + address of a dax device. In case of a device with multiple + constituent ranges, it indicates the starting address of the + first range. + +What: /sys/bus/dax/devices/daxX.Y/size +Date: October, 2020 +KernelVersion: v5.10 +Contact: nvdimm@lists.linux.dev +Description: + (RW) The size attribute indicates the total size of a dax + device. For creating subdivided dax devices, or for resizing + an existing device, the new size can be written to this as + part of the reconfiguration process. + +What: /sys/bus/dax/devices/daxX.Y/numa_node +Date: November, 2019 +KernelVersion: v5.5 +Contact: nvdimm@lists.linux.dev +Description: + (RO) If NUMA is enabled and the platform has affinitized the + backing device for this dax device, emit the CPU node + affinity for this device. + +What: /sys/bus/dax/devices/daxX.Y/target_node +Date: February, 2019 +KernelVersion: v5.1 +Contact: nvdimm@lists.linux.dev +Description: + (RO) The target-node attribute is the Linux numa-node that a + device-dax instance may create when it is online. Prior to + being online the device's 'numa_node' property reflects the + closest online cpu node which is the typical expectation of a + device 'numa_node'. Once it is online it becomes its own + distinct numa node. + +What: $(readlink -f /sys/bus/dax/devices/daxX.Y)/../dax_region/available_size +Date: October, 2020 +KernelVersion: v5.10 +Contact: nvdimm@lists.linux.dev +Description: + (RO) The available_size attribute tracks available dax region + capacity. This only applies to volatile hmem devices, not pmem + devices, since pmem devices are defined by nvdimm namespace + boundaries. + +What: $(readlink -f /sys/bus/dax/devices/daxX.Y)/../dax_region/size +Date: July, 2017 +KernelVersion: v5.1 +Contact: nvdimm@lists.linux.dev +Description: + (RO) The size attribute indicates the size of a given dax region + in bytes. + +What: $(readlink -f /sys/bus/dax/devices/daxX.Y)/../dax_region/align +Date: October, 2020 +KernelVersion: v5.10 +Contact: nvdimm@lists.linux.dev +Description: + (RO) The align attribute indicates alignment of the dax region. + Changes on align may not always be valid, when say certain + mappings were created with 2M and then we switch to 1G. This + validates all ranges against the new value being attempted, post + resizing. + +What: $(readlink -f /sys/bus/dax/devices/daxX.Y)/../dax_region/seed +Date: October, 2020 +KernelVersion: v5.10 +Contact: nvdimm@lists.linux.dev +Description: + (RO) The seed device is a concept for dynamic dax regions to be + able to split the region amongst multiple sub-instances. The + seed device, similar to libnvdimm seed devices, is a device + that starts with zero capacity allocated and unbound to a + driver. + +What: $(readlink -f /sys/bus/dax/devices/daxX.Y)/../dax_region/create +Date: October, 2020 +KernelVersion: v5.10 +Contact: nvdimm@lists.linux.dev +Description: + (RW) The create interface to the dax region provides a way to + create a new unconfigured dax device under the given region, which + can then be configured (with a size etc.) and then probed. + +What: $(readlink -f /sys/bus/dax/devices/daxX.Y)/../dax_region/delete +Date: October, 2020 +KernelVersion: v5.10 +Contact: nvdimm@lists.linux.dev +Description: + (WO) The delete interface for a dax region provides for deletion + of any 0-sized and idle dax devices. + +What: $(readlink -f /sys/bus/dax/devices/daxX.Y)/../dax_region/id +Date: July, 2017 +KernelVersion: v5.1 +Contact: nvdimm@lists.linux.dev +Description: + (RO) The id attribute indicates the region id of a dax region.