From patchwork Wed Aug 16 10:38:13 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: 13354925 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 3E07BC001DF for ; Wed, 16 Aug 2023 10:39:04 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id CE6838D0032; Wed, 16 Aug 2023 06:39:03 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id C96248D0001; Wed, 16 Aug 2023 06:39:03 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id B104D8D0032; Wed, 16 Aug 2023 06:39:03 -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 A15088D0001 for ; Wed, 16 Aug 2023 06:39:03 -0400 (EDT) Received: from smtpin08.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay04.hostedemail.com (Postfix) with ESMTP id 8372C1A045D for ; Wed, 16 Aug 2023 10:39:03 +0000 (UTC) X-FDA: 81129620166.08.21E297C Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by imf02.hostedemail.com (Postfix) with ESMTP id C598C80014 for ; Wed, 16 Aug 2023 10:39:01 +0000 (UTC) Authentication-Results: imf02.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=e3iHgjp0; dmarc=pass (policy=quarantine) header.from=collabora.com; spf=pass (imf02.hostedemail.com: domain of usama.anjum@collabora.com designates 46.235.227.172 as permitted sender) smtp.mailfrom=usama.anjum@collabora.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1692182342; 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=PPGJ+KGWviPQTn3XP+5D2RgTXyx1L3B6OcmlsNFGtCc=; b=x6TM31Ck2v/mNwW8UEQAhaYTpOAJh46MN5Qmx5bW5mSi+KTztAMKZTfJRufK6ZFxFMXpdx n44zC/AQ5AnhItY0TXZpSOuFcX4UsMD9H4jVhfEWK02B5y8FGVQEP8vDmAj76t2GPH8O+p NiFsskC1Fu4rNtElYrAH9P7t5nqs/zk= ARC-Authentication-Results: i=1; imf02.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=e3iHgjp0; dmarc=pass (policy=quarantine) header.from=collabora.com; spf=pass (imf02.hostedemail.com: domain of usama.anjum@collabora.com designates 46.235.227.172 as permitted sender) smtp.mailfrom=usama.anjum@collabora.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1692182342; a=rsa-sha256; cv=none; b=3e3w/q9S8A3bk2AgCswUbuGyLNgWa/e+oldB3eY1lHQ+ICDICAQYaicNVKALfC/c5Hbwhg GUbQtgIsrvqfdZjExWvuLJ3tUUM2fxpQAbDRL+cPtR/3i79kOJVakIH4Ruce6/CeSMgqG8 G0Bdxi3tGSCEVtv8F52eeQn2A3neKyM= Received: from localhost.localdomain (unknown [59.103.216.185]) (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 01F1F660576C; Wed, 16 Aug 2023 11:38:52 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1692182340; bh=++7ZMwIn+CSvHBOzFMinKuXCGuCZi9t/HjmM0x59zug=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=e3iHgjp0vz9wb4y6oDGqUJ53iDYFi2QhrvI77g/46Wr0AYyfY7MTQsZwRobS23htp WwmJaSGlwPUo4mw+QhcURfqIIeZS0G4Zry7EqsW8UVRyWbJbOV3tgBDUoUcITUy1x1 lJicOg2Q4QzRvGzgN4CJ2TFOx0V1xGc1gKnV4S2wjTv5K8DH41j8UeYsqpWgFQGNrn Bl5tGdofZFuVJPjx1Cg0ooR5UeoGf0YedD+BRhitd66eAwrsnAY9QhmWry3btRbk7e 95RmpnJVpkIGNMcBWO6lkyVV3f83eQsyozb6wXgL9lltBkJx3UwB0/AqeykhpWSdPE zhad2yZYQGYMQ== From: Muhammad Usama Anjum To: Peter Xu , Andrew Morton , =?utf-8?b?TWljaGHFgiBNaXJvc8WCYXc=?= , Andrei Vagin , Danylo Mocherniuk , Paul Gofman 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, Cyrill Gorcunov , Mike Rapoport , Nadav Amit , David Hildenbrand Subject: [PATCH v31 5/6] mm/pagemap: add documentation of PAGEMAP_SCAN IOCTL Date: Wed, 16 Aug 2023 15:38:13 +0500 Message-Id: <20230816103814.1522393-6-usama.anjum@collabora.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20230816103814.1522393-1-usama.anjum@collabora.com> References: <20230816103814.1522393-1-usama.anjum@collabora.com> MIME-Version: 1.0 X-Rspam-User: X-Stat-Signature: nkwtokdq535ce1xoyzxnqbjthcheq4d3 X-Rspamd-Server: rspam07 X-Rspamd-Queue-Id: C598C80014 X-HE-Tag: 1692182341-335364 X-HE-Meta: U2FsdGVkX1+ph91c0LYWI/SdesfGAdMMvqb2waKBvmq2MI4a+ukyoU9wGNTxhHlkdktXh6XhDlF42e169AK/AgMnxA2AMbvv7ov7FwFJUlB7qP8Xw2YlV7ExPoB97R7JtUSqAxnjhCCOy6t+YtX87fiht477MMCn0Or4vqOUD+QpLuGz6NPxPkmaNAeZRm25Cb74my9wBBLNKpq8TaEs2GvqGTZo0iY0mM4V3BTCt12/K+i9EfDW9tDGlkP+eSLmESKobixViaTr9MOWhv7+t0sEuwv3OJdlwCbKZQ2cJkRVr043yQI4YLVLSWocJah0UPNdyPgi3/We4PiOwhJ+MrJq2M6CtiuiR5HIcEWEKdyttgqYDzjdYLB/WaOIBXKVudMssQqqsPxp8TfADidAXkyg7FKB8UkwF4IaWxaN8xwMwKOv1+sH3zLa/QGo4UyIm8oQoHumfok3ZPl7lvVMhAUR4NaaDEHQ5i72q9DBp666GifGXmPtyJNvOtOTDuHQDbhH+Xwhuc/Sqy00Fn1senVfPQGwPSeOyQSwqRgRf9/X0HQ5+p9ajEJOLLdci1dU48UHezT30JfWE9/0pvPRxLOgiEBCcIpohLtp9dr+0wqPuhT9rVe5dp0KQKYzbIQ9j3BvZvdvLxZFsDjUzuVidVnldL7t1BkkfvBCzmNmJCJBP0bR5ODMH+IVV2BNy2DU3KiYgpEqTlbSSkDch7Q8GeexEwoxt7Z0/YMoATIrHxITzfDKA81PxxBG26oYjIUYRuHH8pOjd6e8bcpRgFCNCuXM/NDfpIdZwBCfVLhbzPPe5T22sikZQIPapjOi1I8YumenHKsX96xahZcocF1bQOyr/Zzlh1BNt2pPN4FUojEp8Q4Vrewr8RpFis8/3W0R39x6czv0tt0fJK6CdSMySQlxANN4kg74IXrDrQj12mPsg+WjpXHAX7Vo0PzuzHckj82SNs9lqHR54ePbwwy 2rSCVLkq IgH9mLXtfl85mlZE6mzkd6wBSlK8mKTqFcdV+teB6V7yaoRfizQOlWVGnUElQWTI21CvfSJ9onEOwgjUpqhnuPITltIukE3iC8O/vQU5zyfbVhXrDgCOUzF0VxUGIUb/PC7XCvD2OASA2JlWOYDYZSKZRVGdABNZEn6TTOdlGPlQDaOWAJg3SU3G+iMG/Xp6n+U6vsZtFZaNHzfXo9BbmS08KoWorftpaYvBsffJeeH05cH1WPFrVw9pI39oj8CJr+DC8minZWhcfUnGdcxH4J0b0ubv+qkvVFjFoRz2nrIN3qlA= 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 v30: - Minor changes Changes in v29: - Revamp the documentation and make it better Changes in v26: - Update documentation according to latest revision Changes in v21: - Update according to changed interface Changes in v20: - Add new flag in documentation Changes in v19: - Improved documentatiom with punctuation marks Changes in v16: - Update the documentation Changes in v11: - Add more documentation --- Documentation/admin-guide/mm/pagemap.rst | 89 ++++++++++++++++++++++++ 1 file changed, 89 insertions(+) diff --git a/Documentation/admin-guide/mm/pagemap.rst b/Documentation/admin-guide/mm/pagemap.rst index c8f380271cad8..fe17cf2104265 100644 --- a/Documentation/admin-guide/mm/pagemap.rst +++ b/Documentation/admin-guide/mm/pagemap.rst @@ -227,3 +227,92 @@ 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: + +- Scan the address range and get the memory ranges matching the provided criteria. + This is performed when the output buffer is specified. +- Write-protect the pages. The ``PM_SCAN_WP_MATCHING`` is used to write-protect + the pages of interest. The ``PM_SCAN_CHECK_WPASYNC`` aborts the operation if + non-Async Write Protected pages are found. The ``PM_SCAN_WP_MATCHING`` can be + used with or without ``PM_SCAN_CHECK_WPASYNC``. +- Both of those operations can be combined into one atomic operation where we can + get and write protect the pages as well. + +Following flags about pages are currently supported: + +- ``PAGE_IS_WPALLOWED`` - Page has async-write-protection enabled +- ``PAGE_IS_WRITTEN`` - Page has been written to from the time it was write protected +- ``PAGE_IS_FILE`` - Page is file backed +- ``PAGE_IS_PRESENT`` - Page is present in the memory +- ``PAGE_IS_SWAPPED`` - Page is in swapped +- ``PAGE_IS_PFNZERO`` - Page has zero PFN +- ``PAGE_IS_HUGE`` - Page is THP or Hugetlb backed + +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_WP_MATCHING`` + and ``PM_SCAN_CHECK_WPASYNC`` are the only added flags at this time. The get + operation is optionally performed depending upon if the output buffer is + provided or not. + 3. The range is specified through ``start`` and ``end``. + 4. The walk can abort before visiting the complete range such as the user buffer + can get full etc. The walk ending address is specified in``end_walk``. + 5. The output buffer of ``struct page_region`` array and size is specified in + ``vec`` and ``vec_len``. + 6. The optional maximum requested pages are specified in the ``max_pages``. + 7. The masks are specified in ``category_mask``, ``category_anyof_mask``, + ``category_inverted`` and ``return_mask``. + +Find pages which have been written and WP them as well:: + + struct pm_scan_arg arg = { + .size = sizeof(arg), + .flags = PM_SCAN_CHECK_WPASYNC | PM_SCAN_CHECK_WPASYNC, + .. + .category_mask = PAGE_IS_WRITTEN, + .return_mask = PAGE_IS_WRITTEN, + }; + +Find pages which have been written, are file backed, not swapped and either +present or huge:: + + struct pm_scan_arg arg = { + .size = sizeof(arg), + .flags = 0, + .. + .category_mask = PAGE_IS_WRITTEN | PAGE_IS_SWAPPED, + .category_inverted = PAGE_IS_SWAPPED, + .category_anyof_mask = PAGE_IS_PRESENT | PAGE_IS_HUGE, + .return_mask = PAGE_IS_WRITTEN | PAGE_IS_SWAPPED | + PAGE_IS_PRESENT | PAGE_IS_HUGE, + }; + +The ``PAGE_IS_WRITTEN`` flag can be considered as a better-performing alternative +of soft-dirty flag. It doesn't get affected by VMA merging of the kernel and hence +the user can find the true soft-dirty pages in case of normal pages. (There may +still be extra dirty pages reported for THP or Hugetlb pages.) + +"PAGE_IS_WRITTEN" category is used with uffd write protect-enabled ranges to +implement memory dirty tracking in userspace: + + 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 any part of the registered memory or the whole memory region must + be write protected using ``PAGEMAP_SCAN`` IOCTL with flag ``PM_SCAN_WP_MATCHING`` + or the ``UFFDIO_WRITEPROTECT`` IOCTL can be used. Both of these perform the + same operation. The former is better in terms of performance. + 5. Now the ``PAGEMAP_SCAN`` IOCTL can be used to either just find pages which + have been written to since they were last marked and/or optionally write protect + the pages as well.