From patchwork Thu May 25 08:55:16 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: 13254955 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 88EDEC77B7E for ; Thu, 25 May 2023 08:56:17 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 2698D900008; Thu, 25 May 2023 04:56:17 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 21A04900002; Thu, 25 May 2023 04:56:17 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 06E51900008; Thu, 25 May 2023 04:56:17 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0014.hostedemail.com [216.40.44.14]) by kanga.kvack.org (Postfix) with ESMTP id EA7F5900002 for ; Thu, 25 May 2023 04:56:16 -0400 (EDT) Received: from smtpin12.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay03.hostedemail.com (Postfix) with ESMTP id CAD67A0ACC for ; Thu, 25 May 2023 08:56:16 +0000 (UTC) X-FDA: 80828170752.12.C12AE7C Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by imf30.hostedemail.com (Postfix) with ESMTP id 16EE080017 for ; Thu, 25 May 2023 08:56:14 +0000 (UTC) Authentication-Results: imf30.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b="jsxNTj/j"; dmarc=pass (policy=quarantine) header.from=collabora.com; spf=pass (imf30.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=1685004975; 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=EdJHCaKdZfHhuipRxuDYOVTxoS3ROsmXhQ7dL/5Rjxg=; b=M7Zx0+1rXHhVGtz+e/h79ZdrmdlwzDWzuX2K5FQfb17e9mHAq46hhevZ6J68q2BvSQzKEu OksijQEcui3At2vtebXZISauSD29QB7XiwaGfeuQ44s3E2cZdfa3FbxkR5U5+RMHElJYj1 tl2VPcHPvaeZWb7/v0Wv9XAiLbYZoJE= ARC-Authentication-Results: i=1; imf30.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b="jsxNTj/j"; dmarc=pass (policy=quarantine) header.from=collabora.com; spf=pass (imf30.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=1685004975; a=rsa-sha256; cv=none; b=ksdIDBoJavCf8CD+hKCfrvQYe/AEiilsyzQDLThqpukkGkfgLiLVsSv9eq/Y5R1t3KhIiT e8NmUIeGoK4cRF2S6rOqFo++TmSakYfvBg//SvtnXyaNHMs8N/lUtKPKPFLpyfnfbjLVWL 2pIwYL281iJAP5gXYha4vv3yF8JDA0g= Received: from localhost.localdomain (unknown [119.155.11.156]) (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 952A56602F6A; Thu, 25 May 2023 09:56:06 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1685004973; bh=pxNP2M0MAq9fxYUTXNYNkDDZyl8VonsUf4izFOdExko=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=jsxNTj/jffklsz/ozg9DlzT5MjECURg3KOHgLWnw7PQPRA8iVjS6ydLySBxPm4W9F F1jbT4FatWvfdP0ZoTews4XzBjiFCqWSSUKIcTJC/TuKV+En34T6Ha5ZH8eVOk7AXS LNhHBdDnusI7iMeHBtQST3bs1N7iJZCUO5vLTm7bsiQRiPS+4qEJo42R8cUaJ3bJFS DxlAp9tRhZVSRQOO2o1JE7DalEr4uE5H4MIy9EaNbuX7I5aUc8Nx4v8/LepiuSTDZX we/l1QZef1D7BOpLo22S39NaWKCi7sQ4iToLFSv3PgcXcFphcKvEwCRo/RgxZe2x3s RbZUc2lIzkt0Q== 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 v16 4/5] mm/pagemap: add documentation of PAGEMAP_SCAN IOCTL Date: Thu, 25 May 2023 13:55:16 +0500 Message-Id: <20230525085517.281529-5-usama.anjum@collabora.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230525085517.281529-1-usama.anjum@collabora.com> References: <20230525085517.281529-1-usama.anjum@collabora.com> MIME-Version: 1.0 X-Rspam-User: X-Stat-Signature: kumdt7h3mtfweeby6kxz44y7o96gfzkr X-Rspamd-Server: rspam07 X-Rspamd-Queue-Id: 16EE080017 X-HE-Tag: 1685004974-712354 X-HE-Meta: U2FsdGVkX1+dP2nyy4KKDyp55epd8ye+QckhiicLUlZuemEBJUijLEJZlGA7x1I6WgcBYV1ut4Wghv0yRAsKVl78Xu+Cq1gJxd3Vef6IZdGJ7IK8oTFl8yq9eAvA9qD3Q1Xr4JH5XLeqVmznA2r17IJZ0l5RMF6wt961YEEfZJ3aTK6VhfDbSn4Ust8MC8KPKROtZuCmYs0chAWjMsKK4+f7CH6LS9G7+aV55ArFm8xi/51Z5JUUdNOFvfxMWaZs1wkUjDpiM7kRPasOD8YTyOLS8mTb69+RaT4npgBsO3eSzl3a4bQVNDAP3yZRHy9SCpCge2qmbUQtmP9zRCiw8i008udkMIiD20LXL9pYs0uXIpHeCMp0GLe3hjFB7BUSdveE8ta7EOySxYPtiy7cdp+JTuO4of6joRC4Y97Xl1gBvQY638vVgdWLKPAM4xHawSBWCqJc7oBxJNWtnhMuu9J749yMZ0OT47giWgZi9oGgekqmXD0Hyo5hXvnRGNMqv6f+VwmiH0dOyzmmm28rFWnl5aFVtDm9ldSgbiLAvpEkAmKrXG4bqmbbZblb9rnoBQs3D1NjgjiBzRPM0bQLA5rRvs0DC3tXLFUwdprBxqOesfht765btRG7zEcccMZ8sH4uh0KoYZoE997db6bYRugaWCwy2dieVVp5p70MqcqeUQ86aXAMSTG726os/NKQ6sOk69ykM1OswGB6au0h7kTFtLvN3+m23q3OYF8NDJNCOjjLVU1tSTFKtieD9j/rahQnRElFjMt0CK70jiZyyNI2lWT/9tkxvnLOSQqVfOCxTz68Yr6LHazqLkIZITpKZsEcJKhlFLL1da45MwjLniF6b7LuNwFjQcvaLFZQiw7TRp8cQVDFc+ZKQJpcerQzHu6vAZEUP+RHVJKF/U6yNJVMoQr9PHmZpfwJFeZU02vymCJYaqOrEMOY7N08Sc1DxS2kmlwM+AjDVlL5BYS JzamRj6U hNKAO6xX7BhGWS2kKjDq+ilJzREnneTte91CzfCNv+0nOQT/Vl6YGf5fTA9mCqET9e3Eq0z4cULYxKIgL6xh81wENZRILd/Z0hmSbXJxUlLeOXQJ7jPD41yLQ55vUiQEENSONNkonyItvSgeaOHYjTn3K5rbouWEkRUybyEvdQ4xglDF6r5RBZCahJ240MvXfhJD6y2aB4kJjSrS5gKBx/lwCG8+OcvmlH0kPMDXpFCr77Ecqgh62ZaHaFz7EawNL+Z+Q5gLt79tJ7q78g2yDvDsq2+OfLIVbHEV3xTDQ+WaIwT4= 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 v16: - Update the documentation Changes in v11: - Add more documentation --- Documentation/admin-guide/mm/pagemap.rst | 58 ++++++++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/Documentation/admin-guide/mm/pagemap.rst b/Documentation/admin-guide/mm/pagemap.rst index c8f380271cad..3b977526d4b3 100644 --- a/Documentation/admin-guide/mm/pagemap.rst +++ b/Documentation/admin-guide/mm/pagemap.rst @@ -227,3 +227,61 @@ 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/or write protect the pages atomically + (atomic ``PM_SCAN_OP_GET + PM_SCAN_OP_WP``) + +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 flags 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 + ``PM_SCAN_OP_WP`` 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 ``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.