From patchwork Thu Jul 13 10:14:14 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: 119773 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:a6b2:0:b0:3e4:2afc:c1 with SMTP id c18csp1741045vqm; Thu, 13 Jul 2023 04:03:44 -0700 (PDT) X-Google-Smtp-Source: APBJJlGOR3E7luTTUwiSZ+TYOEDG2VNrzj5zamKZNt/MPpQECHVU0IU5dKQzmRglO061aVyvHd6n X-Received: by 2002:aa7:dcc6:0:b0:51d:91ef:c836 with SMTP id w6-20020aa7dcc6000000b0051d91efc836mr1539717edu.32.1689246223823; Thu, 13 Jul 2023 04:03:43 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1689246223; cv=none; d=google.com; s=arc-20160816; b=HXiApcPYJagwMxSBax89CALKHQR0a502rrPWNLp57mjIALFWGAJm5D0IeqK3UxdyMm DhugVpHnC0H0D0nXLWz2NmyO3P0OHkXheOqhsqwJpK7iUySigolZw1Wz21rLv4GtlJjH sXTqxRFXEGXeltyfZNM4azBqcp/GeMGnvwZtdT4ApuHZ8nqMqXs7/KCb4U9nLf19Tdzh u5a7NcmswBll0UvUeP24El8NLNuIyaEaP65dCRg1VyMwnnsODrBtnIXjRDa6GuNItIvy TpKA6jdR+I9j1QSed/EAzzKjw1NaFnoIp0BPARDJoew5aXGa568UEVGYC7ybd7EJ7dL8 PymQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=Dw8wQ7eNGIBkh6JF897pShFRKy2LknhUMR1eis2YMj4=; fh=oQJfh+Vr4T6Dbl3+mbv1Iadpbiax+AEVFgc4RYmtzn0=; b=CZ3RPbHVVlIL5Dn3J0AuaH2bXJ3/4JAizHQ9Rl3hrUmjwCQvQpDJNo2HLmmJte3W85 P8OvkSJG7kTF/6W+yXpVliXwMt9ckr56muZdDPyOeQ+4Mig5dOGEyyObAvxypCI3xN14 BxZBc6sc8tXgykEGKIvHQ1Un1TzL3ooDLes1TL3OtYa+zY6cgAvFekvfCZ+RodEXLmNx hS4N26CBPUX28Vm/V8n/pFGfKDKNjCHBz54JLdYCWbCgA4eeiUlHBYUJ5d06CKbwVBtf NuUE9MXzBBO/C9L15XuhjOfQdibbqplLG3cfBik96gsLx7vtSdeQUU8vYL/bnsWdtj14 976w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@collabora.com header.s=mail header.b=fRggsLw8; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=collabora.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id y15-20020aa7c24f000000b0051dd4949cd2si7267306edo.408.2023.07.13.04.03.20; Thu, 13 Jul 2023 04:03:43 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@collabora.com header.s=mail header.b=fRggsLw8; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=collabora.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234348AbjGMKPq (ORCPT + 99 others); Thu, 13 Jul 2023 06:15:46 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56852 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234144AbjGMKPP (ORCPT ); Thu, 13 Jul 2023 06:15:15 -0400 Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2FC4C2D41; Thu, 13 Jul 2023 03:15:03 -0700 (PDT) Received: from localhost.localdomain (unknown [39.45.151.35]) (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 918176606F70; Thu, 13 Jul 2023 11:14:55 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1689243302; bh=e3RwcWLS0DN4jGAQ1nXg3KEjRQ1a6mnaZglmii6vuAs=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=fRggsLw8SYCGeDn08atN83cllupnb3ZJ5MQpOBR4LrF1xs2o73DV1aNg9wrIu3P0/ JeIbvUrIo3JKmVSoyAWGM1wG1+LPMuBKMPzS8LKuGBLs7iCQwOgL/IRtsH7rfyGStp I1YxKGMMK5LAL70tCirmjl3OMWidVTSRWUbSISebqm69g59sahJn+nTSOPIhLQAHoU dPeq7633pIrGzb2dlrdc9wzPOJOoDXDwt2ZELakrY+HzWYagzcvvqt/NmPTW6/Ev/d 3nwX4XdH0e7eUGozIRv+Zl/B1s2qaHYmaH0/4RO0WxIHyOfe7fOud3c+yyoBure7Cb sxySisZP134VQ== 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 v25 4/5] mm/pagemap: add documentation of PAGEMAP_SCAN IOCTL Date: Thu, 13 Jul 2023 15:14:14 +0500 Message-Id: <20230713101415.108875-5-usama.anjum@collabora.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230713101415.108875-1-usama.anjum@collabora.com> References: <20230713101415.108875-1-usama.anjum@collabora.com> MIME-Version: 1.0 X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_BLOCKED, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1771303048228304566 X-GMAIL-MSGID: 1771303048228304566 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.