From mboxrd@z Thu Jan 1 00:00:00 1970 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 68514C77B73 for ; Thu, 20 Apr 2023 06:02:48 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id BCC4B6B007D; Thu, 20 Apr 2023 02:02:47 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id B53F56B007E; Thu, 20 Apr 2023 02:02:47 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 9CEC36B0080; Thu, 20 Apr 2023 02:02:47 -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 88D7E6B007D for ; Thu, 20 Apr 2023 02:02:47 -0400 (EDT) Received: from smtpin08.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay08.hostedemail.com (Postfix) with ESMTP id 5B27E14049C for ; Thu, 20 Apr 2023 06:02:47 +0000 (UTC) X-FDA: 80700725574.08.BB30EF9 Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by imf19.hostedemail.com (Postfix) with ESMTP id 8BD691A0011 for ; Thu, 20 Apr 2023 06:02:45 +0000 (UTC) Authentication-Results: imf19.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=i02kBRis; spf=pass (imf19.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=1681970565; 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=rLNSWqI0oJaramEXsRfHSXwjckLRVnTAwQtiZ0L+JHyISFIV4L9Xc2W7burWoi5U9hMxIp VXMrwxJbx52VTXGaz4PIOgED7G6KGY7Wk2nRq8JqZV0VsoTufopJ4w5csdnwriBVDK2e4z eydBYd4Y9SClpRjlnUGWphiGQjt610U= ARC-Authentication-Results: i=1; imf19.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=i02kBRis; spf=pass (imf19.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=1681970565; a=rsa-sha256; cv=none; b=JoKOqXUSaBB/rRZDitRIxGjPf8Pl83zoM5KDs8+DpLAajlGMMPxp4OSQDL1UPUcTZjcfbG eDhP35+T4XpEjkEIW4uMzhHzqeVExb4fGEJoWMARwS4xxtaLAtOZE6cZx9U4KPrKF66Iyr FxxiNjP6e0yXr8KtcmNfBy2byTuBzcY= Received: from localhost.localdomain (unknown [39.37.187.173]) (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 AD7F2660326B; Thu, 20 Apr 2023 07:02:37 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1681970564; bh=VHJ3s/rDqou65z21qPz74d3WACjlrCHoe/eBuZI6JGE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=i02kBRisNcthU2e+dB2xOPOGmAQTcZH2Y2k2QlImS0q+3osDWqAqLKPLi2hiRFoKi zSRwoflyXqvxfVIOaFfE+w384UrX8s5OxvJ0H0WXJaB+xYdLqBaPa7dYBJ2u2P1dai OxEw2SAc+UJb4GRSwMxnppLjRiO93MR87VBmypUaSriymZWFuTBqF3bxl2ITHy1DB8 f7vdbHFqaRpz8/2Ec3jeZnSwakJimAfLsljph/VwnUYvm/fiVoT1mYCCdVIahjNonR hQe2bN4jaYqQm1snQ2HN75UfyYb/y3aD7H7G5a3hHADkIhirhooeCHO8sqPhyqAEeA RIyTHfBwmeFNg== From: Muhammad Usama Anjum To: Peter Xu , David Hildenbrand , Andrew Morton , =?UTF-8?q?Micha=C5=82=20Miros=C5=82aw?= , 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 RESEND v15 4/5] mm/pagemap: add documentation of PAGEMAP_SCAN IOCTL Date: Thu, 20 Apr 2023 11:01:55 +0500 Message-Id: <20230420060156.895881-5-usama.anjum@collabora.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230420060156.895881-1-usama.anjum@collabora.com> References: <20230420060156.895881-1-usama.anjum@collabora.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Rspam-User: X-Rspamd-Server: rspam03 X-Stat-Signature: rpqsy7bwu4upeispbe8hbo7i3ppzhgks X-Rspamd-Queue-Id: 8BD691A0011 X-HE-Tag: 1681970565-777085 X-HE-Meta: U2FsdGVkX1/qt2goNGRe0rqbDg8Ef2KXa29UsZhPOlg4QKU2luRwAdf+/5k2cVane1Og3ZQbDYP0OO2t8NaqTFl/oIuQ5m0aVXnxJj5tIuExcGTsWKl227uKg/8qMNguWtMpPZbMglLdOIiUbTPXTLCrDFnXW1jcqnhEvf4GyKpZ2s7o4mL7y8cJtvnqhg4MO63s468lTzRFhaHvd8qySYe1j1EakG3BneOkbDAYpUhDVaWiB6uYqkK01TiMQiG3LYqrr3BHm6gF6uVvrHTX9x6A7J5tWer+gzap/MsjQjnenh9LkBF6Z+4zn8+/4fa4wGXgei4HpU/EC+6C5F4IFZbbLy1AMqXZhLN1QTVmMyTb4FVuhR4OWRkan2ddLpJNMbPHYa03isC8jcIAsqtXHwqh8DHcYrmINQDmIuukZ7qavUoDH7d1/Zpnbvvew54tfS1A1d3VJ0jDLWOzojuwdzPvYZq9hf1B9FKwb6SbzsxrpRo3+L9HtwCOw3vQx41tZK0tFfNgCNvRbsFI8ZvbYoO63VCjqbL/E856+54hqFHVCZU90p0KpCDXfIsD4Z2RBnH+6SE7hjmYsinCTJjB5hWHZNGi8jbLZweOMwojS8JQYJo8CpEOy6gLUOgRrEq60O5wz5w18g5mRrsU4jHguFcrhkiTS5l1XPG1XbgliADT8SdPp6a4PgzmwtIdlJmwYsb3izxNwFSPCxUxOXhobz2SvUBpsoF37JTUlOvsFwF5yUnfVJiykRZW0V6PctFs6I55bgNteFrS4+YCQMpIoAxuN0VpUtSBTcHLcxB03X+UeEtq39ODoXbfAiT1pwjBwLS6l412qzKAJZZiBnd8/Z1TUYz0h9GdVLU1yfHmB0Hj9rBMR7XGIILwv6sJ277pSnjfml0mfloj/JvhAVa1Zq6Kq662ohC9J0Rw6w0HpmElVtS/V8UWw4U+mT04SXS2cLYN8KY7DKyRXr34fvQ dvasyqbn Gew8r9xX2SJSuqsqRVFV6IlVdfCRnrpiV1GcieheZ14Iv92w1SDgr3Mh8ZROikTauYqtdpql5Xk+AtcPHAX2l4eF8y5o1ygX61aoYjxyf8XRtY7veKYOhlp2vT5k+X1vfXjKbLF7ndI8F4tFO8fJqk/qIZ/+dLVJLg2O6Q2CTRg8t4293MyWfh3dOUDh5ZSjaXRi8u1ijhTf4DwICb7rI1L+LTErb7RJzH0y6M3ditytLCTJd/Grtk2YAQxQNoZFPRKHpk98BUnl8gUx5f0CWIGz/zbNBVtlQ1JKkxtDUjgz6CATr/ey/7oA5EJo57wx9O03P1fsBhzoE/JIvJv3GU8tw1n1fmxibkw7Ec2uik+VWOo7qBDe1afMeRzFMpjY3CsW1JlbKfvcsjCk= 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. -- 2.39.2