From patchwork Thu Mar 9 13:57:17 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: 13167502 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 AB6CBC64EC4 for ; Thu, 9 Mar 2023 13:58:21 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 4FBF26B007D; Thu, 9 Mar 2023 08:58:21 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 4856C280004; Thu, 9 Mar 2023 08:58:21 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 3262D280003; Thu, 9 Mar 2023 08:58:21 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0010.hostedemail.com [216.40.44.10]) by kanga.kvack.org (Postfix) with ESMTP id 21D636B007D for ; Thu, 9 Mar 2023 08:58:21 -0500 (EST) Received: from smtpin30.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay02.hostedemail.com (Postfix) with ESMTP id DC3DF120A3B for ; Thu, 9 Mar 2023 13:58:20 +0000 (UTC) X-FDA: 80549514360.30.C2CB583 Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by imf23.hostedemail.com (Postfix) with ESMTP id 2668214000E for ; Thu, 9 Mar 2023 13:58:18 +0000 (UTC) Authentication-Results: imf23.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=K54h775x; spf=pass (imf23.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=1678370299; a=rsa-sha256; cv=none; b=mrNMkSSGyFU+orXZERheUNyghXdMEcmZIpgIq/ouvlHkfEcI0xSfuJG9M1meg6KmrCl7JC Xpfk1kvxcXajl07eQjJSRmgwNHL+p0APTG0K0qt642K5bxgPH59lRTKB3eYv1xMN3vd2GU XeDdze/3QusfLvhpPwMIbw6LFpvMaBk= ARC-Authentication-Results: i=1; imf23.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=K54h775x; spf=pass (imf23.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=1678370299; 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=qYAC9tuUdHdVqfN0XeBjctfhG25j4PNagBa6RvJ5pBg=; b=bH8g8siJrzZaCURxoWZnXdaUBC1yLXgNHayiZL5ds5gpHf238N9RCqbpC7RF1KWophLw+C fyCkcRhl55RWoII2DQhJu87VTMtAF5KOLPCWZ1yz+fffsszC5ScXlqrmvubiU7+aEi+6Zu BLoHJb2PCg4sAOPLIbf50aC9NQBn4YI= Received: from localhost.localdomain (unknown [39.45.145.7]) (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 548EC660304D; Thu, 9 Mar 2023 13:58:11 +0000 (GMT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1678370298; bh=7EyxuoXkxo+wN4f6n92h0Y3XCUTS8ggXPc5h+SWXj0I=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=K54h775xda7qpZGbzNfU2dZdMjuif46vM8oNmxdowyjhbWWPbFACTwGJ1dxQPX950 QJ1/t91wnTBLlf4qMFoXK7HErb8vrQ3e20oghvzHUyZXeksQgp61xi4W1e+RvXehma cGAesjhDySMWRPeRNMBI4DzNt2oRHHnuEIWSij8sddN++4J3rO+CId4RHFfsP4h5Ei A/EiS4ZbkKmqa801VhQmA/ub+YJeK5EF7g0L3DuqQjcXNHP2gUJff+b8udtYvxA/ki 8UI4YBkl2m1qaYiFdJuUheFmkf/kf7FHP08jcO5rUJ4qubMtwm0YshRUJc/76b5CFz sb+TcT2VjZ7Ug== 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 v11 6/7] mm/pagemap: add documentation of PAGEMAP_SCAN IOCTL Date: Thu, 9 Mar 2023 18:57:17 +0500 Message-Id: <20230309135718.1490461-7-usama.anjum@collabora.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230309135718.1490461-1-usama.anjum@collabora.com> References: <20230309135718.1490461-1-usama.anjum@collabora.com> MIME-Version: 1.0 X-Rspam-User: X-Rspamd-Queue-Id: 2668214000E X-Rspamd-Server: rspam01 X-Stat-Signature: ycgx7w9bwuuaw6k6ic3j9f4iqcqwsii7 X-HE-Tag: 1678370298-836391 X-HE-Meta: U2FsdGVkX1/Do9TFJh4UmBsy2XWRjVdBEM/jWg+07V5LBShe+o/i+AIgJO22u6dNOkpxdJDkjipEKF1OLE8Z8xwrSVf4hcLEymHPGWt4HWbHRbQ9vyui68WMQNeA0JWzHxIAaCtaMl/0YJAUL3Fq2cQpQcEsm41WDsbUDHCJt9lgbnHUOqCbhvj1dcAGDst28N7Hz5tvM06DFIMwt92u7KBKGNGCVHHlwLsvVPYj3GCD+mMtAqLxHmsMTmcIq+Gz1NcWaD2Szp5SqmXMi4NH/nXT2hFky+Q4P8rOGrXJZkPEf/ljBOLoXFRuMUsitYZhejvx72C2n5IvVIl0WyHIGMdavO/ywa8o5te4s3GtDqOFNGcHBaLRvBhBKV6Vy2sUoEQyEcnnAZCQJTHUrDiU/FQLb9GkRPlrc6DtVJwUYL5qBj9JMfyy8iOzxyLs0j5hdxhh7zcYdUZ1N/7P8iELtUf2d8RkDXUuhGZmpYeyljGQ6KoIqVznWSg0mdMEn1xNoztjOHDAjzvOSSHzMk2T2An9piLvHVuWjERwZORktgaJ26mZaGD7ya6+3zrc8OFkwgSBtngZUajau39EdtCpzDxeOcfPPBdvN0JQgEXD1BQadC/2WPCXEXkqul5cWUvj3zSW1PYjkMQVmhyB+X/6IGDqDi/nGSPybXivDNxICjHcVRXWyAcL2alT+mmmoZt1OEY8OANM9EZ9Au9KjccJK6GWR+j21r/ZWgQS0OCYdfj2q3ee0Nrz4LFubZcOvUWrGF+W6QPC27SAV1I4AFy8sKrqa+MCYmiaa4kk9X16iX4reDrjE8RJPxBpSg/bo8N1rDxKjsqKzuaaxZ5cm+wryhfy1Wgatq0U2/EeW6tbb4KBVsLkAsi1UUh4bjEszCP53YRxnuV8Ia/JLxRuYzkcYQsYmmlZtsKZzdCmCPCZMVVHTH1gp7wfjBxTMhtaZfYr+dcr1l4e+WCR6mqmcZv +37+4VTR 6PIwILlhCwBcw1Y2FTrGbkWbXFYuVZVLEagSnsV2mChilNdYIADUIYxFcS9GxbR0qalSGfTwmugY+7+Qw7GQ6QZuRZvnGghhP1EqzTE81gRNqKDdgzZUsAZ6cgCwj8eMPIjETs/JWVLU93hjrstwPpLjNN14o6TDbfojozEse0207YbMW/tqlMq5i0rZkAnDly0J9g288FVvVCIQGhwQOZCwAa/IukvRDPaOK7R8GZOX6FNQfOIziGaJ/jwK81o2TXoC2diVrSvePFbLXorStwqqdNkIP/Msyza07exdwqm2TisP7yrGSPnRmYvfVKFZTumKG 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 b5f970dc91e7..41815511011c 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.