From patchwork Mon Jun 26 11:31:55 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: 13292717 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 93E8CEB64D7 for ; Mon, 26 Jun 2023 11:33:46 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 243C48D0007; Mon, 26 Jun 2023 07:33:46 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 1CD698D0001; Mon, 26 Jun 2023 07:33:46 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 047878D0007; Mon, 26 Jun 2023 07:33:45 -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 E39448D0001 for ; Mon, 26 Jun 2023 07:33:45 -0400 (EDT) Received: from smtpin10.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay04.hostedemail.com (Postfix) with ESMTP id BB46E1A06B6 for ; Mon, 26 Jun 2023 11:33:45 +0000 (UTC) X-FDA: 80944689210.10.E9ED7DE Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by imf12.hostedemail.com (Postfix) with ESMTP id F037F40021 for ; Mon, 26 Jun 2023 11:33:43 +0000 (UTC) Authentication-Results: imf12.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=omFMT4Cb; spf=pass (imf12.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=1687779224; 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=UhXzMcMnQjPGccYWtVIQkN07W0sQZXldh8zwiFQ/4q0=; b=wltdjPrILDobDto2MEXSqLtTxSP3EKFOV4SSsyNJcwahKKrJ8Y4TNI1KBi1K9tvQqCUE1j 0bQ/HhjCItcpTRGq5SguqshEsuXnsXHPlmyjJkyFFYroj97O5qDjohMyrf5jp2BBba+iQ1 LKad7DxT801mW1iP9LoQnLGuGe1oGjU= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1687779224; a=rsa-sha256; cv=none; b=Sc3fjqGZNeXJ+V9GSKAO3HeNvuoF4pUfojBOyg/Mjdg+U2YP1JYbJ6UM0igmE1PRG/XcJF q42VPeLwSwexIvc5iQlWYKgcbndnj6gVRyl+i1Dz+YHLZvQjziD22WF4e4VdTUPl4OAP34 uNpcb/1bl8/b7Z/0ThQ2hEng7eUxUX0= ARC-Authentication-Results: i=1; imf12.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=omFMT4Cb; spf=pass (imf12.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 Received: from localhost.localdomain (unknown [182.179.162.32]) (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 478F26607093; Mon, 26 Jun 2023 12:33:30 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1687779222; bh=AomWe0aWnSkkkSkE4EiLnoubW02ICTn60VIov/As8YY=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=omFMT4Cb1/5iPaPJTQAn/3H5yaQWw/LtjMVyQ1o9a40y17TG9RB95tA55IaezVqvt pXKdpXi7qidaTucwpTAXz1NixSXBVr2CEeZDAZZJX4qVsMQrb2nH1Nd7Jd29swXh/w Me4UphoG7bXJC394/haLkNNubyphJZ78nv5b2nY0wsc0Do7+7gPpC1mfvn3RuqDuUu DrlCQMcodpvsZEmHiIn9M6KE4mDzfUwU0O5DATzgIPx5UrONSz3DEQJaZvV2QzIw+P NNQh3xL9QhOa54mBmvIMrUFm6bn66ETCfMiepu5jLXtRiuH/+kxTZkG1SXdcXGXwh0 FjIIbW3ysF4SA== 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 v21 4/5] mm/pagemap: add documentation of PAGEMAP_SCAN IOCTL Date: Mon, 26 Jun 2023 16:31:55 +0500 Message-Id: <20230626113156.1274521-5-usama.anjum@collabora.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230626113156.1274521-1-usama.anjum@collabora.com> References: <20230626113156.1274521-1-usama.anjum@collabora.com> MIME-Version: 1.0 X-Rspamd-Queue-Id: F037F40021 X-Rspam-User: X-Stat-Signature: f4on18x7dmrmqrow7r364ahx6gbq1yfi X-Rspamd-Server: rspam03 X-HE-Tag: 1687779223-448756 X-HE-Meta: U2FsdGVkX19l2SFJmnTZNXJZHBGVa7DUz3QrnDQ8Weu+m0xXyCiwdJtOQi3g4uAqYpfcyZ/OaSzJbTEdD2hjH5qboYeE7bt/2ZfmG8hUi4AbjXtT/vsrvMVfchuPzP1XkjC7EgZYlnRn0khfqnW4yRvt0hDoNKkeM8MIw1T7bxLrlce7fBAd8FZdn4zZfMFzY58I10iMxSCBIQo7+MSuJMsrg587PnCK4DljFTfkJERAo0Gb0Z7nReXvn9ISJKKagT9NX1evmC58iwT/WniBzDHHgS5rbzfQhJymImUhTbPrF9eVDmfJIDtGU1Z5QLmz7CCfNnJX0lfeedM3conL0Nck5xHXrXaXrSqz3UBLtzss/YiHxahRw+Sw9ekBYdHzfvE2oV8Du+QMjHYqMu0FvVt9KDxtNhVFVBlnxjyWje2c+F93JPvx9yfswrtFB+s8j3rztmmLnlxNFpyXm/dFnJKUpjZ8FMts6zIjxivqD/l/0kbyByKHYBvMIRM6ici9ODvFoqJvdVTFYWsKMAXk5668n10DF3rzWa58co1fU/wTjL9tC+LFOItcD2vxrodYWYmOAjdlrbDE9k9+uIX9QHwzs09YvyQL7OLlp0Lrk/SCP+7zCU3oyYtQ1VscI1kHXD0ARUtZp6G1NyKfvRgmQ8Jd7DK6FOg4WzO3E1L4jbaXZ3BP9I/kEyMwrdEMKekgXEY28kVRvaQ03qJcD6By1CPsvUus1H2UQjDNdI8GksrjnS+7n0xNOfB3p35WogcnHJsnsitkTzqMd6sbrJuqHqXv4wsAnILhb5UBuPy4WNpaOq3+ksagGqDduTafK1JBZuLS/+mWMwUQMujLqetTfxn9HQjfuhlpcHM60buerhMLktF1ULVE6TSZm8l+n3nHddVrX1ZAYoJTRAhQq9bTnjBe96lRfI4k3EDTaS35vH/Seeugb/w0reCIpWrevCIn2vLMy/lBBZ4D/4zNenj aq+BFHBH ESqw215LndHbd/X0z/uO2AbV4R+K4HD3m0Pf0X8cdf15KVfKCUkUw+flzhzjfCeGq+dWlmHfHhobRh0Rgvc9d4AMX4nrb7AczxYn4vIACPLqOywHhpUzR/3jvYCrkjrR9fpZc+FZ5soqSRRcT80Dnf3fTdtmoDQM/+6g5Q/dp/bfoE4B8BZ77E7xYzpeH7wsyyR6C6tcEtwCFQ53oB6k9nAe96ZeBWXFPkORRBO9ASo6nPTvnebRv4uZnGbWi+OR43YHqMDtI6mbOj38YlbvAejMktfsV1Zj042q2VSzJgb1bBFg= 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 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 | 58 ++++++++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/Documentation/admin-guide/mm/pagemap.rst b/Documentation/admin-guide/mm/pagemap.rst index c8f380271cad..84c14ce86ad4 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``), swapped + (``PAGE_IS_SWAPPED``) or page has pfn zero (``PAGE_IS_PFNZERO``). +- 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`` unset, ``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 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.