From patchwork Wed Jun 28 09:54:25 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: 13295488 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 58035EB64D7 for ; Wed, 28 Jun 2023 10:00:33 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id EF7528D0003; Wed, 28 Jun 2023 06:00:32 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id EA7BE8D0001; Wed, 28 Jun 2023 06:00:32 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id D701C8D0003; Wed, 28 Jun 2023 06:00:32 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0012.hostedemail.com [216.40.44.12]) by kanga.kvack.org (Postfix) with ESMTP id C81238D0001 for ; Wed, 28 Jun 2023 06:00:32 -0400 (EDT) Received: from smtpin28.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay01.hostedemail.com (Postfix) with ESMTP id 853921C88E3 for ; Wed, 28 Jun 2023 10:00:32 +0000 (UTC) X-FDA: 80951711904.28.65DEE6D Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by imf10.hostedemail.com (Postfix) with ESMTP id AAEB0C002C for ; Wed, 28 Jun 2023 10:00:29 +0000 (UTC) Authentication-Results: imf10.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=Au7dywa+; dmarc=pass (policy=quarantine) header.from=collabora.com; spf=pass (imf10.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=1687946429; 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=Dw8wQ7eNGIBkh6JF897pShFRKy2LknhUMR1eis2YMj4=; b=puM2oiLuBEoboFgJvim12E2nw6FZkmhxc4ASzRuYOHyLO6y40e0Ar9F1e1cgIE91YRtOKp Wy+vJw2pR+2kh/1WYqsqhe054tdcAKuJOZtNh2SCuLjf3XFwZAtcEPvnOwQ1MUqzySYaFj Jgi0ymWLxPMFLbj6Y0N81FPZeKby7Dc= ARC-Authentication-Results: i=1; imf10.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=Au7dywa+; dmarc=pass (policy=quarantine) header.from=collabora.com; spf=pass (imf10.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=1687946429; a=rsa-sha256; cv=none; b=ncuPv55AZrrm9Ky+gDiHNgrXrPpaiiKeMzzky/ERf+LEFZYwwmz+puwGettLMQ986Pi2tN 6AGJpE6KIFAmT7k6gh/yv8jQCfGPgZXKcwvgSASq1biEyXW1PhZ8gQ3LLDUiOse05SLxBs dhziLPjo+dvmcw2XOW5Rt4NK/5DmiIk= 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 DC2306607173; Wed, 28 Jun 2023 11:00:21 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1687946428; bh=e3RwcWLS0DN4jGAQ1nXg3KEjRQ1a6mnaZglmii6vuAs=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=Au7dywa+LE2W/wzm1TZcFBU+0kVFgSRzNrCRHPyEN1RkjnVULKXhniptPZLhcXUGr fSyahjqicrlbD/KI7XQwVreKPLo3XDb41yxXNuHrB2+YA39EYGBqHVC0hQWG13sqVt +M87CEvDDDgGHS0pWrp8Bvsw6ZpnK9qnrHstqqEulP60PFV4uCx92Hcka5asggs54o 1PmzIdB+caWqskcSlIfmrLCWP23Hcyc1HYM2wAY4xIWS+pwcOVkpc9fedjwAfn5XeL a8wJugNVzjrEdARZswXT6SzFU7Ih65MTILYlAn/BdXsw/xi6zw8HQiiZgaIfj6RfI4 PHx9RLfaakhCQ== 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 v22 4/5] mm/pagemap: add documentation of PAGEMAP_SCAN IOCTL Date: Wed, 28 Jun 2023 14:54:25 +0500 Message-Id: <20230628095426.1886064-5-usama.anjum@collabora.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230628095426.1886064-1-usama.anjum@collabora.com> References: <20230628095426.1886064-1-usama.anjum@collabora.com> MIME-Version: 1.0 X-Rspam-User: X-Stat-Signature: 5yyknhan9irka1ot1dztfet9p4z459ro X-Rspamd-Server: rspam07 X-Rspamd-Queue-Id: AAEB0C002C X-HE-Tag: 1687946429-532005 X-HE-Meta: U2FsdGVkX1/42ttGRrP0StkuRvUg7W9CakMOhlZuyRveGYEKeAAK5GlKWA8Ax6panyos6yoK9/bZxjRtIMryIf8BxCUx4gPjsULaUYjwgNLVa21MY0D/op0iHBlf0z3bmpyJozfQUoJ7qXyQXLUmazyXgBvnHvwdVfnifznJmFtHr7pW2SCgsdYUQ7MyUm6lNsaR1F5kvxTuOnZPD3cGwqJadAqaN2AvY1JD62S693HlmlWWZOWxraQZc+gnrmfxdu0OCEIAEUtPPHm32hjpBQumSyY5sW3hu6x/hoHgLLkbZnfbBXDAiZrB0xWNnogZCuG8ADkpqxXMWpkD2KyCsN0PTave8ZW6d2cuog/u+Qo/NXRwElKzmOJKwiyHlO6bjgkmzehkSWgJXkSFDPf29q+cIhETBspucFjikTbaf1D5m5bQPQSf7/+nwXB48kk/C9yXcamXZkoLMYNaokaxhigHe55Gre6dB8mRRdUJcmwJTkHZF5wODTSEfrVg9CCSvrJqNyuSj/P/NUCPRK63VATavRP3FHqWMcvpQBGsLMDU5pfC3b8TfB2aw2zUlspUUYhmjHkmjqkm4PF29gJh29qZBtm21NxmogcJbdDKPxeiOvOoZNl0VmWvtkc4RvXaqRBT44efgqBoabbpJ3cK7dvzlVYpSMqe3lxRQsSpK2IMWBDEwHXMjsdmF2yLnyVT+7Txe10AwJg5GGbRkWdKRAYls1fivsbrt6XcIz79Ne9K/mKDDsjyE0h6lWH2z+Ru7acrtlnVUyoNbfapYho6feWRPgeEfOpJeZeWhChmBypDipIlhP1SQr6cHcWp/R9N2JsIf/FZs55+n+sMtO6iScTY8FBKpT8QEytKV4bH3Vha8kW8+dgSbFhn09c7VuMSeSGFQGjEaLfBX4gguTWM84GwGOZAECDgE7denYLdxTf6qvA4Pm3j5RuZE0RmM4Agil0wvg3VDOwuGLib6I5 5o1rbiUX 9sBXMA6qsHl8vflxnuaw9ChCPFm/FlmRCJqtkzNhhfOEnD+DZ7EvCkOken6s6+V1S8UpqhgO5Y6fguC659c97wAdAT9uWCKZXO/9LZX98msLzRvMF7wiRdh0BUT1fOJfdOZrw6i30Y1RQhf7SnM2HufkL7BCKVf2rgKojgwDyob+zgml1R0t7szwW9xv46OCJEqIRh5LhB17tQlWUyYGKfByHLqGvlVmWXCHGvzTsqidyT5e8KHuqey7Mj2R5/lsV7aRZNwm3cphkjL/BISRqVqQ7/pnUWsRZ7P8lhXrmtWi9Lpo= 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 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 rst --- 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..4bdad8eff009 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 ``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 ``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.