From patchwork Thu Jul 6 06:01:46 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: 13303223 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 CBCB2C001B0 for ; Thu, 6 Jul 2023 06:03:05 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 6856E8E0001; Thu, 6 Jul 2023 02:03:05 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 6351D8D0001; Thu, 6 Jul 2023 02:03:05 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 4AE9C8E0001; Thu, 6 Jul 2023 02:03:05 -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 3CA9B8D0001 for ; Thu, 6 Jul 2023 02:03:05 -0400 (EDT) Received: from smtpin22.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay04.hostedemail.com (Postfix) with ESMTP id E6F1D1A0C0B for ; Thu, 6 Jul 2023 06:03:04 +0000 (UTC) X-FDA: 80980143888.22.6448FC2 Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by imf17.hostedemail.com (Postfix) with ESMTP id 6A9E240014 for ; Thu, 6 Jul 2023 06:03:01 +0000 (UTC) Authentication-Results: imf17.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=fnIRNVqv; dmarc=pass (policy=quarantine) header.from=collabora.com; spf=pass (imf17.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=1688623383; 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=lJ2tXW4ZC7vbfwo8Au3g8zdjW/0torrm1eM3fOhcjEha0hFa74PlxUBc+97nZ9rcE1X3g5 c/9SL4E0mq4NfnshUQdwso75YWUs4Xoe5WW+JBt3crAYhQcosToTW1JOYT5cs0Cyej2KhT Y0g+Cam/2mEzzi02twSNmyczXXtrDj8= ARC-Authentication-Results: i=1; imf17.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=fnIRNVqv; dmarc=pass (policy=quarantine) header.from=collabora.com; spf=pass (imf17.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=1688623383; a=rsa-sha256; cv=none; b=ya2m5m9xznuNHQWwb+ciG45mtY5D3di2UNMbu2zc8Q+rbDeQdza2Tu4S0pkmciHG+TzJ6q qQ8OQ7u8Fh4UrQYewVwG9cu1MFB4/53hP72m6igMO/ZWn8D+SCc2IRf21VYhQ+HrOpjq5D au33tUdi2kxU+MmURojHCAaSUOFmfes= Received: from localhost.localdomain (unknown [119.155.52.241]) (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 51003660585C; Thu, 6 Jul 2023 07:02:49 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1688623379; bh=e3RwcWLS0DN4jGAQ1nXg3KEjRQ1a6mnaZglmii6vuAs=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=fnIRNVqvBAMtY5BqqL2/rG106bUdzD2PcuHLChgnz5hP1KoVl2SlcrZRZF/T79Zsm 2e/c6Z7zu+W9F9Afc4+U7Y+RH+imh5/Ngw02dpAxG/lXljuEa9UDCoct4doBP2J801 H4u2op2XL4ebfN7ZJCiQitgCm6VDf6Fu8xs4x3vuMknedhG/SHxUYt0lPW74jTPPGS WrzJ2NIKB0pPvMdDf2waL/OWggcPzgEMDbo98jFckTle14sEE8AetqAEQMRuGKIeHf wFxupAxKfpvYfXge/G73teJp0Rgq6O1rE+VOwfvyJfhMkmfr13H8dsx0aMrtvDMaBf qhy3qpPz31HIA== 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 v23 4/5] mm/pagemap: add documentation of PAGEMAP_SCAN IOCTL Date: Thu, 6 Jul 2023 11:01:46 +0500 Message-Id: <20230706060147.444375-5-usama.anjum@collabora.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230706060147.444375-1-usama.anjum@collabora.com> References: <20230706060147.444375-1-usama.anjum@collabora.com> MIME-Version: 1.0 X-Rspamd-Server: rspam09 X-Rspamd-Queue-Id: 6A9E240014 X-Stat-Signature: s3neosgqox14oiywqp8qu3st4jzb4smx X-Rspam-User: X-HE-Tag: 1688623381-890546 X-HE-Meta: U2FsdGVkX1+b6Cfj1qX0xkwRK/DEHaOdX0C9h/Y/GyLxto80FpgV81NDcMpm9oESpzO6/JuHDEwKsM3Vra4Mx/KxqHZh1I14+IZnPrU9gmejYeRmnD5LMwvt+QZgvLCH06jVjSP7xwoi/v6wfCnJw++PLz8ssebY2Q1z+Jg5jNsF8MqJqvWg8JMzb01ZpgCt83d8GvR8VM4HDGcnZaX2YtFAhzozXuMCCzI8XhVvM6OT6HeJxWuHwt1NGjORHd4fKf1F38tt/uiqHgggI17DpuFSt9ARNK+xaZ+byOaYdlXJbz9ZYt0jdPGUxG+g9Gw78T422nbjw8q4/ar2Rf1WQZLUnTGAPdRevubEFWoLEAKVEH9KCOb0jW1Nugd2IT6Hs1OoVg/Q9m1sRhKn8sEshe1UX8pHxrmda1qFe3lXLtaM7AunwuE4/fDD7gMgV3Ss7s8h6at1etyiZgmjbofWAU57h/Qzrb31HNX7KyMxjNZGy7CwQri05p8EOzpd0THdANFM0nLOnNeTJquhmOdnHJU9lpI3odaSgFInOKvb1MtGJV0qWFRpiJKbExd+hmZVYs/yO9itSfnN6m2RYqKW91GDp/VXtXES7W+cjX5rD1qLYszq99xzFuBepmo3OiLzPF5vsEbT2iglk9BgJWD5ReJiON3vnzfl27k9LPLwkMnSOfiT6f6pfv+0Gk9cc/l2RCnOZ91/5eUZs89lFU91bkl/mqRDCG0tahXTa5Rimy5hj79S9yUNdAm1K6jkG64IbaZEAaD82luilCeHQjnA8MAe00fnxTI8Id2pS/93g8aRnC/CwoBmWn3r28YhJhcELbIu1kBKpx9sh8KfMWt+wd0FG2lvZFlA8Ql/j4EtYrOoQy1xXJ831DAseZNTqa4hTcVrI3R58VtRR2S0uj+JvKQrPB5DTb3aNJX9Mm11AQZLmmb0wqO+MD8RD9siZhaoLUcdGAUy9+rX4dFtR7O lyChHkih ED7rNzfcomNwnoFHXEZ28jVI48DQn0hhwGPByM4K96lLKFlco0PxXyyz4+pH8Hy5/PG3G9oRYkZCCvNpSn6I5lJMjl8v7778QSyOr6kdaOKeJTEj+IQph9qKENLpDMBI2vjA07dZ9pMGL0KQwtsLxaHd2gIBvOv6EaYZvOIHesGLqsJy/KdRwOjTf4kIbpXEFjFiOF0uH3iPgQPsNiRCklGpWoVoKxklNjiYSYwt6Z3PHaFozKriMQr6hdvGb0yQinlNCtPeSeOoe+AWI6cYJv+dmaLgcgSTDISOAiIZTc2Q5p5Y= 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.