From patchwork Mon Jun 26 11:31:55 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: 112892 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:994d:0:b0:3d9:f83d:47d9 with SMTP id k13csp7426129vqr; Mon, 26 Jun 2023 05:00:47 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ6p4h5g1DoX0poSeKE3t0oylwWYSF6n+E52th5mRzjm4Uv40o7s8+lGSfqY3Ajahg4HzUtx X-Received: by 2002:a17:903:2341:b0:1b6:b703:3703 with SMTP id c1-20020a170903234100b001b6b7033703mr3720366plh.37.1687780846977; Mon, 26 Jun 2023 05:00:46 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1687780846; cv=none; d=google.com; s=arc-20160816; b=oQZNZA1UeAQUJP5rnh+ljaa6YhQqf+AQvuoACrrbIXyv32BoRTkJs/yiv9zuqSL/bm V92Oo/3EbIthAF7d+HRCmRkKs2AzBl8FLZoTpyI7qxlIvO5d4XhTLLWeGlyoL9duT+Vu G0p14Oi8oUaQrSCSwqWyuPvyccKQa8g7J+k/niNE7pFGc6qeznc1wB7zc4k0H5RrrbZe vUrjEMYeij9di/2JCu2DNLF2AU/SnYmNHw9+jx+pPk9yBgk9X8p3887AB80CaMWGHmZR I1XS4y1Rgci8/e/Ax6HsUxsi3xklHPXSAAEzsWzOaHJTOvw5gSafoe+5x5/GBC4XfO73 E9zA== 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=UhXzMcMnQjPGccYWtVIQkN07W0sQZXldh8zwiFQ/4q0=; fh=89AHENmwRQvai1+q30H62qXkn4c48Sl88BBnnpqTygs=; b=N2BZMsI/ULvNVaFEfhXG1e4Dns0DnJ1bNR+4KoU7Mr+U0MYQoTTBQp4q83UR3wlhmr YND8FNBcoshJpQPdjG4QYPXTb9PEEuLXDlHEWrVf8OUM9mH//uQxID8sw01W3jx4b0Xd vqZiaVokSi+5yDkDE+/9XggpvmIGWsXjadyIbM+MFvlKdxtCNhhbfQZB8N2gAeYz3W6q jbaculRTDXh+SZmJBIU7rkxKqpIrD4SDn9w9VDNWuO3GeE0Gena1O8jBqn9Mu/aFOGqF 6Ty78LFH3aBkCqh2TYhBqNfi7/mE9ptqsqiGwX7TOOLzYBqORCM+KkiqkreeLNWOEJAr itVw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@collabora.com header.s=mail header.b=omFMT4Cb; 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 o4-20020a170902d4c400b001adbfba9c29si5122145plg.409.2023.06.26.05.00.33; Mon, 26 Jun 2023 05:00:46 -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=omFMT4Cb; 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 S230013AbjFZLeN (ORCPT + 99 others); Mon, 26 Jun 2023 07:34:13 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34800 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230200AbjFZLd6 (ORCPT ); Mon, 26 Jun 2023 07:33:58 -0400 Received: from madras.collabora.co.uk (madras.collabora.co.uk [IPv6:2a00:1098:0:82:1000:25:2eeb:e5ab]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0198E1987; Mon, 26 Jun 2023 04:33:43 -0700 (PDT) Received: from localhost.localdomain (unknown [182.179.162.32]) (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 478F26607093; Mon, 26 Jun 2023 12:33:30 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1687779222; bh=AomWe0aWnSkkkSkE4EiLnoubW02ICTn60VIov/As8YY=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=omFMT4Cb1/5iPaPJTQAn/3H5yaQWw/LtjMVyQ1o9a40y17TG9RB95tA55IaezVqvt pXKdpXi7qidaTucwpTAXz1NixSXBVr2CEeZDAZZJX4qVsMQrb2nH1Nd7Jd29swXh/w Me4UphoG7bXJC394/haLkNNubyphJZ78nv5b2nY0wsc0Do7+7gPpC1mfvn3RuqDuUu DrlCQMcodpvsZEmHiIn9M6KE4mDzfUwU0O5DATzgIPx5UrONSz3DEQJaZvV2QzIw+P NNQh3xL9QhOa54mBmvIMrUFm6bn66ETCfMiepu5jLXtRiuH/+kxTZkG1SXdcXGXwh0 FjIIbW3ysF4SA== 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 v21 4/5] mm/pagemap: add documentation of PAGEMAP_SCAN IOCTL Date: Mon, 26 Jun 2023 16:31:55 +0500 Message-Id: <20230626113156.1274521-5-usama.anjum@collabora.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230626113156.1274521-1-usama.anjum@collabora.com> References: <20230626113156.1274521-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,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: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1769766489152374426?= X-GMAIL-MSGID: =?utf-8?q?1769766489152374426?= Add some explanation and method to use write-protection and written-to on memory range. Signed-off-by: Muhammad Usama Anjum --- 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 --- 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..84c14ce86ad4 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 ``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`` 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.