From patchwork Wed Jun 28 09:54:25 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: 113779 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:994d:0:b0:3d9:f83d:47d9 with SMTP id k13csp8817274vqr; Wed, 28 Jun 2023 03:30:57 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ5WkEF+Iudu/Jw3A+Tfe4pvUDHyy6pEkNot6owBSUPFEPa00s4ZZlXWWL8WxymCvNJ0t3SE X-Received: by 2002:aa7:d988:0:b0:51d:a181:d78e with SMTP id u8-20020aa7d988000000b0051da181d78emr4663113eds.27.1687948257339; Wed, 28 Jun 2023 03:30:57 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1687948257; cv=none; d=google.com; s=arc-20160816; b=ntoRvNd3oL1loJj7Meq9H2FIR/DxpdfVGrhNgrUhPumLpikA7UIVwSOWZu9EkKXDwG ZLCeHILYs25+YrV3bS23zY/5yBLEYlz+V2lRx24vtXJIAehCc/mUCjR8pbcOMqWlW4ga 1mCME4FDZEwfZI23YcDwq2q2UP7DYfh4jMkypPCET+EeCXGnYLIDiAKoSDEzFBudBf2T g5gqHxjJgqbCFoqs8oO6TwOrYslsg4sHRD6wYjbqEV1/NQpLeqPgtK2WHhIAYfKiSPtx E+i6hVIEu5D6Q09TlzmeTsHtCf94YHVIAcnx+ahoWlJNktAgWHNRhkhK2FUbCutxDeS6 uJIQ== 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=89AHENmwRQvai1+q30H62qXkn4c48Sl88BBnnpqTygs=; b=CGBAofcR0ShjTQ/7U4n2793CXKpu49TRlamqgTBMdvN1GKh4HAmQ05spUW9FaoOa6g 4jQ/RLbv/UAPaUrVNvmzrADM7oIkeFyIjt1+3+c7NetcoMU/i31a+ACyFGJDrPc5fKV7 xTJtn16W97FKOADBHKiHGazT8Y7pNZzCgORRbDvTbRxlwxmeXcBRm6jafjxFyfoQT2fU jIPToB4PZdptDVM+yOUCZ6uPrkn27zGGGJD9b8iyB0crXaWaQmVI0t5xWHi6iIPiKoqy TGPiucHCWT3oaMCoWWyc9yASe+1hLzrl3obS8jdoh/4cVkJ5blqxeHoH8wRzOHPvXEZo o/+g== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@collabora.com header.s=mail header.b=Au7dywa+; 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 n2-20020a056402514200b0051a5178ab0esi4708898edd.463.2023.06.28.03.30.33; Wed, 28 Jun 2023 03:30:57 -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=Au7dywa+; 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 S229840AbjF1KHk (ORCPT + 99 others); Wed, 28 Jun 2023 06:07:40 -0400 Received: from madras.collabora.co.uk ([46.235.227.172]:46864 "EHLO madras.collabora.co.uk" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235110AbjF1KA3 (ORCPT ); Wed, 28 Jun 2023 06:00:29 -0400 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 DC2306607173; Wed, 28 Jun 2023 11:00:21 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1687946428; bh=e3RwcWLS0DN4jGAQ1nXg3KEjRQ1a6mnaZglmii6vuAs=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=Au7dywa+LE2W/wzm1TZcFBU+0kVFgSRzNrCRHPyEN1RkjnVULKXhniptPZLhcXUGr fSyahjqicrlbD/KI7XQwVreKPLo3XDb41yxXNuHrB2+YA39EYGBqHVC0hQWG13sqVt +M87CEvDDDgGHS0pWrp8Bvsw6ZpnK9qnrHstqqEulP60PFV4uCx92Hcka5asggs54o 1PmzIdB+caWqskcSlIfmrLCWP23Hcyc1HYM2wAY4xIWS+pwcOVkpc9fedjwAfn5XeL a8wJugNVzjrEdARZswXT6SzFU7Ih65MTILYlAn/BdXsw/xi6zw8HQiiZgaIfj6RfI4 PHx9RLfaakhCQ== 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 v22 4/5] mm/pagemap: add documentation of PAGEMAP_SCAN IOCTL Date: Wed, 28 Jun 2023 14:54:25 +0500 Message-Id: <20230628095426.1886064-5-usama.anjum@collabora.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230628095426.1886064-1-usama.anjum@collabora.com> References: <20230628095426.1886064-1-usama.anjum@collabora.com> MIME-Version: 1.0 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?1769942031994125578?= X-GMAIL-MSGID: =?utf-8?q?1769942031994125578?= 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.