From patchwork Wed Aug 9 06:16:02 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: 13347451 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 B6922C001B0 for ; Wed, 9 Aug 2023 06:16:50 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 5583D6B0074; Wed, 9 Aug 2023 02:16:50 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 506E66B007B; Wed, 9 Aug 2023 02:16:50 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 3F5E28D0001; Wed, 9 Aug 2023 02:16:50 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0010.hostedemail.com [216.40.44.10]) by kanga.kvack.org (Postfix) with ESMTP id 2FA586B0074 for ; Wed, 9 Aug 2023 02:16:50 -0400 (EDT) Received: from smtpin16.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay05.hostedemail.com (Postfix) with ESMTP id ECDBC40D32 for ; Wed, 9 Aug 2023 06:16:49 +0000 (UTC) X-FDA: 81103557738.16.4535C4F Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by imf25.hostedemail.com (Postfix) with ESMTP id 30615A0017 for ; Wed, 9 Aug 2023 06:16:47 +0000 (UTC) Authentication-Results: imf25.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=P6Taw50l; dmarc=pass (policy=quarantine) header.from=collabora.com; spf=pass (imf25.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=1691561808; 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=vQEABLOiYASfKGN+kJcFTbE8TxJb5utgEVWNwJV3QQM=; b=LkyecIkSjNm8MMxOSZVoSLGzGoTs7EecOXwDMSPW0sSEkDcJ9t4xSKGuysDxPZljy+Mp/J Lu6oAAO65BipYdO9zFSQOy7VVH+5JZ/qN7z2geXoZ91TdIqCbFNgVpe4I/uJX3f5nqthJS oeVTfMUb8Jx7EzNjyJkHyanQBjOBgWs= ARC-Authentication-Results: i=1; imf25.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=P6Taw50l; dmarc=pass (policy=quarantine) header.from=collabora.com; spf=pass (imf25.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=1691561808; a=rsa-sha256; cv=none; b=hoePtAvfLXjxzH/TKXXn8AryU4AaCIIsKDjo9dDMNFLEFRpR3+6v8bZ9ynSZjYiDM1QwwS zaQEv2qAwPGN4exzsQF2zz3bIefoP+ULcasBTXD9DLuTVYGsVSxxSchUUxrHOM+62zHPFC xyaGfhfSgF3qmDXOSaE2or2sP0E2RFo= Received: from localhost.localdomain (unknown [59.103.218.230]) (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 56D1F66071AC; Wed, 9 Aug 2023 07:16:41 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1691561806; bh=Mo1XH1UBRenLTz5BwK9wfXpLgt7ICRwepxhynxV74M4=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=P6Taw50lgoVGvlK3peNoytHwfr1OSKRL8n+NQXDiql0Hpr2eLngLQZ8FTwHTYLZxh rVN2y9n1p3sZnf2SlZJ8SwfLOvU10PR0a4maXtQNQnwEFQfFDdonnaRRmZaobDzo3j p6teanOBdwlQezTBrap9hxBXKGKetGLUSH0WbttWM2/HB2gRpfhY/GQWVU7eNrUzVA ssOMRxdp9K6ESacqejBh2poBtvZ2E3VejCyjvxz1X/rmDDVuIO7jzAt/fcLeo8Aqog f7Fgs3qHc7rwRsw6C6gps7SET13O3zbtu4szSpbFECehC541w9qDh6ckQKg/G33CaQ FlM4zC0k9dPTw== 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 v28 5/6] mm/pagemap: add documentation of PAGEMAP_SCAN IOCTL Date: Wed, 9 Aug 2023 11:16:02 +0500 Message-Id: <20230809061603.1969154-6-usama.anjum@collabora.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230809061603.1969154-1-usama.anjum@collabora.com> References: <20230809061603.1969154-1-usama.anjum@collabora.com> MIME-Version: 1.0 X-Rspamd-Queue-Id: 30615A0017 X-Rspam-User: X-Rspamd-Server: rspam05 X-Stat-Signature: sqjymjdbaani1w6k567cjyo9gemxfnxc X-HE-Tag: 1691561807-52954 X-HE-Meta: U2FsdGVkX1+e4bqqXjmLgGiKFU9ZmFAIRK86G2uH+P7nbBhhkhH7Q/4MypXORa1jGM1FoRcUsEpemjIK43xEFnydLqKZ8VIwFRu8GmyULuL1ccNj+26zMOZhwZ2bFZAgTvk4ZfGSMCP8W93F96gyA/qDz7qzWeG9NLbFE0ELtTvxYJzG06Z2wuBXE9rDtnmUdvex53/9NBJG455wl0kr5OvcHLWe3Z0snQB87UE1Y4tadwbJ7L5aGiqpOengA5P2D9lWmUvypKwNdFLBTpG/kJZJzOiDMknl4IhI43aKQpiTi4VZQDVVfXrqnfQQWq6JtoSd5WMoLkL1/PJBUM1Fretuj+4htgj3sTuPQTz8T6egIXZilri+afi1bo1SIVih8O3WlZx6IwI4b1G9yXzL4/zyJTCFPIiOPhMCXt6rgulLA6ixQOVFx7oSID5R1Hj5AFFD4/4TlS1pUAp3ZdN3byV8zElBM5uouI6ArMzfisTGXxWODIERzjVlkLN6uSPhtsF3eibYDxdEEk18e9wS7vjPTqURjsfIrHCGUJJhfQAqPGHIfo1GfJdP2qGug1tMMyK9ehPC7Dwag/AR71QaNkm/y3C/NI7D3P/HCL/CIophWRJs23EoxcHkkw94f2lgHt1kghkBDz5idYBr24F/FH8T2pcVQk55Z6Aqmk03H7kUZ51ssIFHm7zQjJYKmheRgqcEtbcnBL/4IzUDZpm9hX5I57GD83yc5HqLZ2gS3VEDvw9P+TjwpbdXMRhCfJVph0qVvEASE4PjxLcuh15LEGxNPEKMsEqfZAQYTQD1yynme+ibSsMLSV+NvvG0Fw0OjnJl9L/tj3EdSv0WukmhDhczo46RHCsbWWNmTm7QW8UwUg76Jus3aEwwvxOefJWW8wet/3F2KVYqI81mngsWEq5T+jKorhJLyT5bRDxfnO7Buq9yjvy2DFmNrshsLjkRKj1MWdJ1bSfn1/I4BPu uI3yUnZi LqU3I6ABekCp4FvqwJ6ZJIg5olxtGXrsjyNPn5ek9NFHVzzfNjNLexrJ1f7G3LeNzx3b8sQfu/f/A5Wh9NwAWrSXrjyXVccgoizMbOTwhiPyyUd33Vd/TzKRn3AMTKiLqSyXIIPrtq7HMJC7DkJGyAAuyVu7rE21Z3bHKM+hFJoPyEUwD40T6dyPech+jTP3v77mjIs1RQspiz81d7/s/2sEfh/HFHUnbppkmR96zmaGbSFc6JE/KFcQHhgVUyEM2tHgUEIB+8LU/ylhD7MXB2ApZfv6PU1yZJrrk4rItfpRAMQY= 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 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 | 64 ++++++++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/Documentation/admin-guide/mm/pagemap.rst b/Documentation/admin-guide/mm/pagemap.rst index c8f380271cad8..ea18e4575902a 100644 --- a/Documentation/admin-guide/mm/pagemap.rst +++ b/Documentation/admin-guide/mm/pagemap.rst @@ -227,3 +227,67 @@ 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 Async Write-Protection enabled + (``PAGE_IS_WPALLOWED``), have been written to (``PAGE_IS_WRITTEN``), file mapped + (``PAGE_IS_FILE``), present (``PAGE_IS_PRESENT``), swapped (``PAGE_IS_SWAPPED``) + or page has pfn zero (``PAGE_IS_PFNZERO``). +- Find pages which have been written to and/or write protect + (atomic ``PM_SCAN_WP_MATCHING + PM_SCAN_CHECK_WPASYNC``) the pages atomically. + The (``PM_SCAN_WP_MATCHING``) is used to WP the matched pages. The + (``PM_SCAN_CHECK_WPASYNC``) aborts the operation if non-Async-Write-Protected + pages are found. + +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 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 ``category_mask``, ``category_anyof_mask``, + ``category_inverted`` 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`` unset, ``category_mask`` + is set to ``PAGE_IS_FILE | PAGE_IS_SWAPPED``, ``category_inverted`` 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, ``category_anyof_mask`` is set to ``PAGE_IS_FILE | PAGE_IS_SWAPPED``. + 3. To find written pages and engage write protect, ``PAGE_IS_WRITTEN`` is + specified in ``category_mask`` and ``return_mask``. In addition to + specifying the output buffer in ``vec`` and length in ``vec_len``, the + ``PM_SCAN_WP_MATCHING`` 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 housekeeping 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 any part of the registered memory or the whole memory region must + be write protected using ``PAGEMAP_SCAN`` IOCTL with flag ``PM_SCAN_OP_WP`` + 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 and/or optionally write protect the pages as well.