From patchwork Thu Jul 27 09:36:36 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: 13329870 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 C2C4CC001DC for ; Thu, 27 Jul 2023 09:37:42 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 5B8396B0072; Thu, 27 Jul 2023 05:37:42 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 568086B0078; Thu, 27 Jul 2023 05:37:42 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 455F16B007B; Thu, 27 Jul 2023 05:37:42 -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 366006B0072 for ; Thu, 27 Jul 2023 05:37:42 -0400 (EDT) Received: from smtpin04.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay08.hostedemail.com (Postfix) with ESMTP id 0EBB71404EF for ; Thu, 27 Jul 2023 09:37:42 +0000 (UTC) X-FDA: 81056889564.04.C7A13B1 Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by imf08.hostedemail.com (Postfix) with ESMTP id 4B68A160016 for ; Thu, 27 Jul 2023 09:37:39 +0000 (UTC) Authentication-Results: imf08.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=bahu0xsK; dmarc=pass (policy=quarantine) header.from=collabora.com; spf=pass (imf08.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=1690450660; 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=r3tCSCinPX8yZuD3VDUinPE9daLiXsRS3zTOBgttAwKqcs9hkuiTPXA5ccyHQ8hT98o7On ZNfsRSILHoMuWPXtN4zxqs8SPX3elDNL8cZ7OcxngWswNQ2vW4JRFGNuuDelPRbky1Dzlb j8LDx9zstG87ZdVvHA/AJ9RX/zgFXp0= ARC-Authentication-Results: i=1; imf08.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=bahu0xsK; dmarc=pass (policy=quarantine) header.from=collabora.com; spf=pass (imf08.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=1690450660; a=rsa-sha256; cv=none; b=sAG3xu11AgmYrt528cR1j/wlq7leBNdrzIWCENQljibekSOOqOg16TApLre0nG4zKBD4im hzfvfqjXxohaclR/IYHmouINZrdrlk4dgifZ3w4o6CTjNNwVuOSEfNGrYt+qyNstpGp5ED Gl7zrMsIAUhxa9N1Ev3bSuNbCLRljYM= Received: from localhost.localdomain (unknown [59.103.218.24]) (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 E47F56607038; Thu, 27 Jul 2023 10:37:30 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1690450658; bh=Mo1XH1UBRenLTz5BwK9wfXpLgt7ICRwepxhynxV74M4=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=bahu0xsK6HI6zjMfzEFdauBquly6f0Cj9Ts5bKiDmBUzRoz4o8a4JLy3Wi0d3unlx M1IqHXK5Qs7PVGs+HnXTVc8HirV6KOzWFv65QDtaukMswMhcBMTF7BJy9uWOqqFFY0 k2mcx7BLx9k0fsmf6o7FxkjUi6o4pqpI7IhuRApmmGsNABKouI8sJi3xB1L+i7m/cp 9RdYbNrCx5HOnqPMua1d+NWzsdotfh05TTjkhI6VzKgOGD4heJtFF2jXy1JEUcNdxN c2Jy3TayyKvGopOE/WAdWso+UO3OCnkFZy7uzF4QqSxrZLn3N7g8BzQ77WY/VWVlAd 1xPokEw+jbbGg== 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 v26 4/5] mm/pagemap: add documentation of PAGEMAP_SCAN IOCTL Date: Thu, 27 Jul 2023 14:36:36 +0500 Message-Id: <20230727093637.1262110-5-usama.anjum@collabora.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230727093637.1262110-1-usama.anjum@collabora.com> References: <20230727093637.1262110-1-usama.anjum@collabora.com> MIME-Version: 1.0 X-Rspamd-Queue-Id: 4B68A160016 X-Rspam-User: X-Rspamd-Server: rspam02 X-Stat-Signature: jkbkxf9o8ic6rn1ttmtruw7pr3txeeq5 X-HE-Tag: 1690450659-996132 X-HE-Meta: U2FsdGVkX19zFzgv/LQDYyXlZ2no/kyZy5CG4HfpbHf6eeDE8yo2lA3X+pL3QU7CRpt2XgIKpdo5Pyz2DNd9Uengd51QlBFaAX4WXEJMLPBsr7XC6e6ng5DL82KQ7Xcw/BrVENgoGgqq/vPfed7jCYiodTrq+urXul2GhhD/vq4flm12KmBDoqsF774AhwA6+vzT426/pirRuMs+qwtNYeTUyiucSTqZoYNtCQP4eWDqbsRN/adqf5Fk5GE87mNm4IxBth37UF8F6s/hKszbsCFoD05pUuuy7pOQv7iHyAFHf6k2IWEUtMWM2pq6Ug9ud5phqV7BlyxkqSe+sPHzgetvO2Gyz4+9fimg6SFRgDPfYE9qQslvLJdTpzvrm6CB5G0bBVfkWkjLFSCeC+8SPn9n1MAuwP/aRlVQPvmj+GIPPIAYOFbAHGzr6mmb64zzmqNoSUO7YRRUfRZ1o+e2IjwaJLvmvCWmVZnOdy1oWZ95V6+jxlGtMTHNA5znxElAX/zPYzLiNtkaV4J14y6AL1EVlJPug3jKtO21197+qtDJx9gkfXkkNhmFwJFUwSDu3bxq8hkWmmrGn2BsQnsxNpEEJ9Nl08lz/C5BqgvbaHu5hF8ch3ies5ef5yhZ+5IO2jf2qMI3boENUX4+q4enJyUO2xnWPWJcp/h9S0CuBT/gqFP0bQn0+UJN//X1g84GPLSGLK7Xlg76lPGOyyMCYvO9ZDTm3DVenKxovCJCpkdiHHikpOGSjtZfZ8l+wBsrhKI31XRolp1jZeLD8YM6/YIb+zoz90AChgXsjH/1vEBgk3jtOlnEt+X8tzJwTrfjxHbdbkiyWIy6KvsAy+OTfqJPDbl3MEk5K5Y27ULOKYi5fDugxX5lzG7aJ6GjWHGtTWCxvxj8bf6Y9Zjk6xm0VbZ790iYdnvG98JWFwqHUfcysLzF1geuRuJQO4XmJ6HV0qXA3u3/rc7Vp1Tja6K 2O8hQdRp YDHotqvFCXsm6zDTGs4JyD2x+BvUmSx5KYilDkuvtVCZlJrGVS4aYCqYPrTHgSzOvd7Do+XgX5xel2XreMkOEoaXMecNoly1sFj6GZqIBFoj7boszQ5fl4MUh5fE8lzRmr+J6Y/Qw8vWQOn/FWkZEIrqwCkv+vC1+iEfR+US26oT118q/KsQYlT3ZliqYM5YbH0PwsVj1ANhc6HHgcrYbFbo/7EdI48VaJM5voa5jo6HGdG6dWqkXZ5ThcznSZBMoHtp174OKNZ99QUHmGD6DfSGE6mhztqAitBjtTVcNecvHEpg= 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.