From patchwork Thu Apr 6 07:40:04 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: 13202959 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 E99ACC7618D for ; Thu, 6 Apr 2023 07:41:02 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 835816B0078; Thu, 6 Apr 2023 03:41:02 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 7E5856B007E; Thu, 6 Apr 2023 03:41:02 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 6AE576B0080; Thu, 6 Apr 2023 03:41:02 -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 5C0BB6B0078 for ; Thu, 6 Apr 2023 03:41:02 -0400 (EDT) Received: from smtpin13.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay02.hostedemail.com (Postfix) with ESMTP id 29BA7120191 for ; Thu, 6 Apr 2023 07:41:02 +0000 (UTC) X-FDA: 80650169964.13.A23F755 Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by imf05.hostedemail.com (Postfix) with ESMTP id 536D8100010 for ; Thu, 6 Apr 2023 07:41:00 +0000 (UTC) Authentication-Results: imf05.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=MvBethjn; spf=pass (imf05.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-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1680766860; a=rsa-sha256; cv=none; b=eouPyo1GAiFY1VWeDaa3DIltNbFmWbntdRkh+18o2uF0GvcAMtPFNbvmi29VwRkvAYVt7j vyPflYNenKgAInF6OjM06xoESIUWiSyfREgmT+CS4dwWvZriQ9pa4BkQzjkSQVCQnPLKiS IOn/k8YO/F7XkUg2qjXyOU6JltFNKlA= ARC-Authentication-Results: i=1; imf05.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=MvBethjn; spf=pass (imf05.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=1680766860; 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=F+WQuLC1n0O2BZP66V17ufLd2LvhtjD6Q2VmEkbUcS8=; b=OEizF+IZzdhvlhMHNuEM+j85dFzSl1vOjtFtKEMs0NA2ZF3To6M9YX60y2kUhLg/t+Q54a A1IAdGD0ightcARaqlBxlZ0qefXk/nm/4jNJMgOtRltwyWLuixijQCfqbW6y1Fc+FBJxxy RUlgXTKX1IOgv10IvT/Rptyqz5Gi88c= Received: from localhost.localdomain (unknown [119.155.57.40]) (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 9B3FE66031CB; Thu, 6 Apr 2023 08:40:52 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1680766859; bh=VHJ3s/rDqou65z21qPz74d3WACjlrCHoe/eBuZI6JGE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=MvBethjnSqLziHDGb5lsW7clVQOn8ym6wN8Ykia5gTWmyLYjUxnGEQsodqcFWL+nL LT/acVr12kRkaX71ZZ2vhqMX2beAZulOESNLUtvhn0CZzHjw1DkqW7p6n/t0+Bl2uf bezEYGX8mqyIlWZmmcaNWfSsJvIkuifCtL49PqGSt49Eh83d1uRgdXKa1rYLXt9uvG ZkvdolZMQmk6+8z74c7noGTFGgm8Ma/BGHU0u80QEm1DWav0PicHznNY3CFbtPq/nB vfCB9gwtk3JjcLNvOYSgG4bX1FQmzr+GP2o4cAk8Lobsk39kBT0Z0vIEWmgahGaxXP oiCE19+8VKvCg== 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 v12 4/5] mm/pagemap: add documentation of PAGEMAP_SCAN IOCTL Date: Thu, 6 Apr 2023 12:40:04 +0500 Message-Id: <20230406074005.1784728-5-usama.anjum@collabora.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230406074005.1784728-1-usama.anjum@collabora.com> References: <20230406074005.1784728-1-usama.anjum@collabora.com> MIME-Version: 1.0 X-Rspam-User: X-Rspamd-Queue-Id: 536D8100010 X-Rspamd-Server: rspam01 X-Stat-Signature: 311kpkg9w1tszuiytc4pxwgu5rsdxppt X-HE-Tag: 1680766860-778954 X-HE-Meta: U2FsdGVkX1+hVrziYqD1Lm9PV48uyBPqPT6Sc3/nFJAj1ZLkDNL9kXTVFMmJJ7+TeeUvOiuWsUt6+3wQIomEnHGanuBe+eVyhPI/Z5nkWcPwBCWfXmyev0k2kowrCmqCKC/0hmMLfw1n3paUErDb2UAvFTLdne8kVAO1RNXK+3IJun5T9mjX1GuuI68giWDYPEFDzj0t6fKFV3NVQ/k/LdTEx/i4JIix5e4kAhEHKmDvtAkNyXyTo89ih63t9uMUt4nblahEm5j2nzLGUNHuvnzQowbZa87Wy/5tztU1Ind3cXdiTqKhOeoYQCl/x/Zahn1BkOgqaFqIhV/qUsGCC/8/f7PZFqpfTtL7bYXX+xh4zZrB40F+sjJakYrIqA4Xas7oIvCyZk0XlaNMUiM/1txbpD0hil5bpmlIeEnB968bUJG5+IBCNObcmR0D3PMloJ1EOleJj2/Bi8Fs3zV2iFvM6vSlu4abzTy21pIMr2Sv97QHaN5+MJNdWipPi8yWbYwpJWSrAGiBaf8e5B0l/amxqhaWmkoiUmQPsz6IK9eDNr/5ETuPftkALN3/q+BPULjtUT1IZPwUWtE+yqTByp5iCRlybVsZKRktL3UOf//dowH7Jzs4aTBIZbbccbB7mNCmqMIK+Qgl1bI2hKaFMAk4vOwdGGGNIQS/lxmAxRGk3cqKlbou7csVqjq+L2zjtxlxl2Gix0khsOhM8Rkwf9/S0A2uXXt1s0h4JBpqn9GFXti1CHR0GVg5gRRcw7bgO8uZeCeBq8ZtfuSHrFLB5fssvxPYzdKeUv3lHSWtp30D+fVV9ANeLhlzqMlEBs0WMaSZ+EeiMdRBUwDwaO1aWNJ0kcokgE3scO09AzbUFun3+vaxfrEzTVgVEvEm9TNseIyaZYnib0E+qatsC5CMt5W57S38wmJ1eE3Ng0Jod5Ovsnm2pZEhHvEOtPuy6168caX5ozBW5rg6/V9z7u3 GYxAeiv+ Csao0vjfxxbSLkB10xIV5on+xppKrBo38d9vWbb9rM3g/nPMEte8rq/JA/pevcp6kndCluxHwpHroS17HHrQguoMWyO4awgJwRQEPJtuYMYmfRNLiEgzOizoc/BVxwpTdKelguz9Yoe6iEUaNsxhYGSli1e5gB4elD3nCzX+ofg5mGE86/D7rZiWZ5rLvQJRkanJ1FV+9f3zoqBbjxGe1mFV2SdP5ZSmfg+GNl/B9mWoqU5eYbbvtGcDFfzpG4Vn/OfRveZa/ccRl0Bz+esLDjWQRE0r8YqnxLFnhjVfoYcorZ5oTXHruYSwr+YhNLrxgAyzL 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 v11: - Add more documentation --- Documentation/admin-guide/mm/pagemap.rst | 56 ++++++++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/Documentation/admin-guide/mm/pagemap.rst b/Documentation/admin-guide/mm/pagemap.rst index c8f380271cad..a3e08f15b433 100644 --- a/Documentation/admin-guide/mm/pagemap.rst +++ b/Documentation/admin-guide/mm/pagemap.rst @@ -227,3 +227,59 @@ 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 write protect the pages atomically + (atomic ``PAGE_IS_WRITTEN + PAGEMAP_WP_ENGAGE``) + +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 flag 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 + ``PAGEMAP_WP_ENGAGE`` 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 the ``UFFDIO_WRITEPROTECT`` IOCTL. + 5. Now the ``PAGEMAP_SCAN`` IOCTL can be used to either just find pages which + have been written-to or optionally write protect the pages as well.