From patchwork Wed Apr 19 11:07:15 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Muhammad Usama Anjum X-Patchwork-Id: 13216656 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 C3DCFC77B75 for ; Wed, 19 Apr 2023 11:08:14 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 16737900002; Wed, 19 Apr 2023 07:08:14 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 115A88E0001; Wed, 19 Apr 2023 07:08:14 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 00482900002; Wed, 19 Apr 2023 07:08:13 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0015.hostedemail.com [216.40.44.15]) by kanga.kvack.org (Postfix) with ESMTP id E455B8E0001 for ; Wed, 19 Apr 2023 07:08:13 -0400 (EDT) Received: from smtpin10.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay03.hostedemail.com (Postfix) with ESMTP id A7573A01ED for ; Wed, 19 Apr 2023 11:08:13 +0000 (UTC) X-FDA: 80697866466.10.3CB1D95 Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by imf29.hostedemail.com (Postfix) with ESMTP id D01D6120023 for ; Wed, 19 Apr 2023 11:08:11 +0000 (UTC) Authentication-Results: imf29.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=ZyIhqV+j; spf=pass (imf29.hostedemail.com: domain of usama.anjum@collabora.com designates 46.235.227.172 as permitted sender) smtp.mailfrom=usama.anjum@collabora.com; dmarc=pass (policy=quarantine) header.from=collabora.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1681902492; 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=F+WQuLC1n0O2BZP66V17ufLd2LvhtjD6Q2VmEkbUcS8=; b=wjiFt1VZKDWZ/BitkH/43GHcabGMWribrxHtlnGIJDUf42nQcw4kRnD3I3B4363FtZAbRE U3l1bto2PfGCzhBcyV7yfqiqdHhCeCEhnk2i2bLTrXRDibE7kmmHBiRjLuMxTz7JEcC2US 4ofQA8FdS46Ubw83EDy0CkIJENtkeds= ARC-Authentication-Results: i=1; imf29.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=ZyIhqV+j; spf=pass (imf29.hostedemail.com: domain of usama.anjum@collabora.com designates 46.235.227.172 as permitted sender) smtp.mailfrom=usama.anjum@collabora.com; dmarc=pass (policy=quarantine) header.from=collabora.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1681902492; a=rsa-sha256; cv=none; b=lYzrjTmNbHxN2/8Kkfv2Hda80UsXYMpIb2HJLfNOQzCr072QV6qxtpFVHFz8w2uwRggwpu POzFa8I677eWcNyBrHz/95o6whp/BMu6ZiaOM/5CyODenGdtMILqZBzPZev4itzvKC2met B9DYu/uvsQpI4nkwSRzBpE2ThHE6emg= Received: from localhost.localdomain (unknown [39.37.187.173]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) (Authenticated sender: usama.anjum) by madras.collabora.co.uk (Postfix) with ESMTPSA id B8C046603260; Wed, 19 Apr 2023 12:08:03 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1681902490; bh=VHJ3s/rDqou65z21qPz74d3WACjlrCHoe/eBuZI6JGE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=ZyIhqV+jzRQ8tc1t8+z2GtTNWF9UnWPqd2i2lRIzfUcpwPw2g1LwVv4h6LaKI5VDm L3yzgeS9Q9NdTrwXZazNhdZEW7p8ysLdtc/KCiw8UHrI33Pw2JlSrWgK/u+b5KVAOU wpKwEM/EErGeqjX/fdGSwMeIQCd96DzCr8VTBvCjHiJRw1Z/UZd5SBZtg5Q/YbjjiT 0dkM59K/z4vnfgeMDcPOH+gzMNUVfZuZ9HX5y70HE09sZiOfIkoa0yr/zIy3mbpQoX V9EoATsI12+glMTUufvXkIGm24wP7PV2CLIISWh0iToEa6yA6zK5LXxWgR2nLsNQ0d 2Yf8fhp+fctgg== From: Muhammad Usama Anjum To: Peter Xu , David Hildenbrand , Andrew Morton , =?utf-8?b?TWljaGHFgiBNaXJvc8WC?= =?utf-8?b?YXc=?= , Andrei Vagin , Danylo Mocherniuk , Paul Gofman , Cyrill Gorcunov , Mike Rapoport , Nadav Amit Cc: Alexander Viro , Shuah Khan , Christian Brauner , Yang Shi , Vlastimil Babka , "Liam R . Howlett" , Yun Zhou , Suren Baghdasaryan , Alex Sierra , Muhammad Usama Anjum , Matthew Wilcox , Pasha Tatashin , Axel Rasmussen , "Gustavo A . R . Silva" , Dan Williams , linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-mm@kvack.org, linux-kselftest@vger.kernel.org, Greg KH , kernel@collabora.com Subject: [PATCH v15 4/5] mm/pagemap: add documentation of PAGEMAP_SCAN IOCTL Date: Wed, 19 Apr 2023 16:07:15 +0500 Message-Id: <20230419110716.4113627-5-usama.anjum@collabora.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230419110716.4113627-1-usama.anjum@collabora.com> References: <20230419110716.4113627-1-usama.anjum@collabora.com> MIME-Version: 1.0 X-Rspam-User: X-Rspamd-Server: rspam03 X-Stat-Signature: 8mcajyds4e34ry7mbux59n7hqetyzej9 X-Rspamd-Queue-Id: D01D6120023 X-HE-Tag: 1681902491-574534 X-HE-Meta: U2FsdGVkX1/BebwSm9ESTyswproHe7zLdWWQvwGVv9L6eEl4FuE344BcSkpcE6+Ni0tFceDxvucOZhSOWFQmOeT/v5TrAnAwbqdom5qgKoZema7KjEns3+IdahrRfxpmMEUP9k88pT74OHcb/M6sifnPKkS4m6UM67oxsWTBkiN/mbBtZ1pffOP6oBxHBhJwl4CoeTTkK1udKGAdZkcz80tQ2hQGKalNAbQCXXcCQKsOMMNXSWKSAThIUulBwJfLUetusGI0st7BFC7lwf4La2AjRjH0zf57n4PjvJbd8Vdo6CIVv2KnBrbLsptfI/biGkXn26A2BSqJqzfN06K0f45MyKxvn+UswGzpRU/65zUL1kBTtqeVtDigsjj4jKM+eftLCRFdWVkzxHzFNoU2InwjgZgmtvw3w/Q9akApnSLXBq6NrAHI/lsZOPCNXLVa6NF889MfNT53o/ptRG/anitggu4dx6DdvQev//Y8AvBeiMX9f4R8fccqqZ9WaxMFaof2IGfZBEp9posMVMzUjlWJB4cQfsSsWCwm6QGwaHlJKufldc7fI0ykbNDWIK/Qv4f57Z1mQRrLIkOQOQDEHOI0w9aAc8PMhUHMGlIQ2XbBhyCvftDrHW/EdEzpiFjhU75pqyXJ2epi5twTOVZhBOhOHvo9RrOZX6NBq+VSdkNWQvG1KU2+x4YFEga5Balhljmgg1gIyuAafup3pZAOe5oY9LQvF4aQYX9SRLK76RuyYbg8AQfu2d3ioNOjfHsEiYvO8zOO1LMfgtzcuPQ0i0+9TPCNBABvEWrMhacSU3kLrOV424bf0kRrGP5blSAi8S13bQ+Yt9tosMPl5h/7zQTLZXUa6BWIZ4KzgcqsnL0njIZMfPxU5OVwlY4i80ad0B7ftw3Sk9fBvskCFnEeb0yLo7daSGxlPtSnpyw/HWCeWGkmYiaLAIyNV5v01aztAM1EemjsyhuZnnqvKfE lpdMH+Wg 28DgrD5yQjNBhJfc+F8o5kQ8P6pmMv0NomiSlKQSO4iHC02xh7d5p0BmAoAjSnMCLL9l9o31m2rFq+JBiX2gFeaOLI+/biTMDeVz0fCMDdsApqgnmpUiMEotZ6tV3RtLitkzpDHVD+EI/GbI3ywtF0nXzB1Ilzw1MCsg7SgH4yEPaNDwMzx6PaHjfRDZAu21Q5qZ0hafll/8UY033+v/zY1iNJhFJscDL225ZX/O+RmrACagaDiHW7bdyOm0OwCjkm/E1DYNuJ06yd63qZLg1aAevqVIFwtdZXyfh7a3D5NBxVt77oDEIrIayI9EqpEpHCfzyMAGx61OqeHAnJDeIICKZFV2gjy7gpl3VlZdp4OpXwINrr4tp9HXtx/+QAeQfbzS4kAOhu7/Xguw= 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 some explanation and method to use write-protection and written-to on memory range. Signed-off-by: Muhammad Usama Anjum --- Changes in v11: - Add more documentation --- Documentation/admin-guide/mm/pagemap.rst | 56 ++++++++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/Documentation/admin-guide/mm/pagemap.rst b/Documentation/admin-guide/mm/pagemap.rst index c8f380271cad..a3e08f15b433 100644 --- a/Documentation/admin-guide/mm/pagemap.rst +++ b/Documentation/admin-guide/mm/pagemap.rst @@ -227,3 +227,59 @@ Before Linux 3.11 pagemap bits 55-60 were used for "page-shift" (which is always 12 at most architectures). Since Linux 3.11 their meaning changes after first clear of soft-dirty bits. Since Linux 4.2 they are used for flags unconditionally. + +Pagemap Scan IOCTL +================== + +The ``PAGEMAP_SCAN`` IOCTL on the pagemap file can be used to get or optionally +clear the info about page table entries. The following operations are supported +in this IOCTL: +- Get the information if the pages have been written-to (``PAGE_IS_WRITTEN``), + file mapped (``PAGE_IS_FILE``), present (``PAGE_IS_PRESENT``) or swapped + (``PAGE_IS_SWAPPED``). +- Find pages which have been written-to and write protect the pages atomically + (atomic ``PAGE_IS_WRITTEN + PAGEMAP_WP_ENGAGE``) + +The ``struct pm_scan_arg`` is used as the argument of the IOCTL. + 1. The size of the ``struct pm_scan_arg`` must be specified in the ``size`` + field. This field will be helpful in recognizing the structure if extensions + are done later. + 2. The flags can be specified in the ``flags`` field. The ``PM_SCAN_OP_GET`` + and ``PM_SCAN_OP_WP`` are the only added flag at this time. + 3. The range is specified through ``start`` and ``len``. + 4. The output buffer of ``struct page_region`` array and size is specified in + ``vec`` and ``vec_len``. + 5. The optional maximum requested pages are specified in the ``max_pages``. + 6. The masks are specified in ``required_mask``, ``anyof_mask``, + ``excluded_ mask`` and ``return_mask``. + 1. To find if ``PAGE_IS_WRITTEN`` flag is set for pages which have + ``PAGE_IS_FILE`` set and ``PAGE_IS_SWAPPED`` un-set, ``required_mask`` + is set to ``PAGE_IS_FILE``, ``exclude_mask`` is set to + ``PAGE_IS_SWAPPED`` and ``return_mask`` is set to ``PAGE_IS_WRITTEN``. + The output buffer in ``vec`` and length must be specified in ``vec_len``. + 2. To find pages which have either ``PAGE_IS_FILE`` or ``PAGE_IS_SWAPPED`` + set, ``anyof_masks`` is set to ``PAGE_IS_FILE | PAGE_IS_SWAPPED``. + 3. To find written pages and engage write protect, ``PAGE_IS_WRITTEN`` is + specified in ``required_mask`` and ``return_mask``. In addition to + specifying the output buffer in ``vec`` and length in ``vec_len``, the + ``PAGEMAP_WP_ENGAGE`` is specified in ``flags`` to perform write protect + on the range as well. + +The ``PAGE_IS_WRITTEN`` flag can be considered as the better and correct +alternative of soft-dirty flag. It doesn't get affected by household chores (VMA +merging) of the kernel and hence the user can find the true soft-dirty pages +only. This IOCTL adds the atomic way to find which pages have been written and +write protect those pages again. This kind of operation is needed to efficiently +find out which pages have changed in the memory. + +To get information about which pages have been written-to or optionally write +protect the pages, following must be performed first in order: + 1. The userfaultfd file descriptor is created with ``userfaultfd`` syscall. + 2. The ``UFFD_FEATURE_WP_UNPOPULATED`` and ``UFFD_FEATURE_WP_ASYNC`` features + are set by ``UFFDIO_API`` IOCTL. + 3. The memory range is registered with ``UFFDIO_REGISTER_MODE_WP`` mode + through ``UFFDIO_REGISTER`` IOCTL. + 4. Then the any part of the registered memory or the whole memory region must + be write protected using the ``UFFDIO_WRITEPROTECT`` IOCTL. + 5. Now the ``PAGEMAP_SCAN`` IOCTL can be used to either just find pages which + have been written-to or optionally write protect the pages as well.