From patchwork Tue Jul 11 12:52:40 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: 13308670 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 0B824EB64DC for ; Tue, 11 Jul 2023 12:53:52 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 797E36B0078; Tue, 11 Jul 2023 08:53:51 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 749966B007D; Tue, 11 Jul 2023 08:53:51 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 6103B6B007E; Tue, 11 Jul 2023 08:53:51 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0016.hostedemail.com [216.40.44.16]) by kanga.kvack.org (Postfix) with ESMTP id 50E746B0078 for ; Tue, 11 Jul 2023 08:53:51 -0400 (EDT) Received: from smtpin22.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay08.hostedemail.com (Postfix) with ESMTP id 24801140227 for ; Tue, 11 Jul 2023 12:53:51 +0000 (UTC) X-FDA: 80999323062.22.2AB3A2E Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by imf10.hostedemail.com (Postfix) with ESMTP id B7D45C0009 for ; Tue, 11 Jul 2023 12:53:48 +0000 (UTC) Authentication-Results: imf10.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=MdARlwDF; dmarc=pass (policy=quarantine) header.from=collabora.com; spf=pass (imf10.hostedemail.com: domain of usama.anjum@collabora.com designates 46.235.227.172 as permitted sender) smtp.mailfrom=usama.anjum@collabora.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1689080028; 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=Dw8wQ7eNGIBkh6JF897pShFRKy2LknhUMR1eis2YMj4=; b=rIx/dddpH+8EfjXi+GSzsfbM9KXFb9bQDnKww0CwrUxZVwuitWys3aP+LFHAMsjYUFEkWi DwP2gG4bXNC5OhnIuPtcyw/SGodZDpe76b1CEuvntb2n7VmDnOfaYwDBJ2PyxkmLpkLVa3 nd228aSNpUO1kQy7ORFmBxp8bNDHLfc= ARC-Authentication-Results: i=1; imf10.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=MdARlwDF; dmarc=pass (policy=quarantine) header.from=collabora.com; spf=pass (imf10.hostedemail.com: domain of usama.anjum@collabora.com designates 46.235.227.172 as permitted sender) smtp.mailfrom=usama.anjum@collabora.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1689080029; a=rsa-sha256; cv=none; b=Ryu/qJvlowvfwcUiMF8fc9l9laJzRX4mfzTobj2dXKbjW3KwtP+JrYYk73uO535SY11t1x pxFi6SoVBtdVhG5yTzqMVDhLg/CSrvo7XXSfYZvxzhp5d5RoFZx05UHiz0K9aLDEGwxq6V p4Yy9HC9ScoHy0UsGwj9zitznGmeYOg= Received: from localhost.localdomain (unknown [119.155.40.122]) (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 B61B5660217D; Tue, 11 Jul 2023 13:53:39 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1689080027; bh=e3RwcWLS0DN4jGAQ1nXg3KEjRQ1a6mnaZglmii6vuAs=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=MdARlwDFQDKScisXGCtEwJ9rzc9ku5dA1jLj2OZ1T00ExwO5tt2SmfX1hEFuAsd9+ 6LeHKU7sHQoFP2XdfPRRF6vEThylU/M7M/rM9KfOsOqm8k5/fgryA8ToQZ2t9iiJge cq3UOpVkRrhLNthVwSvFMjCp2MlXgw7HH+aj6Loi8jrF4WkHUqFK2Un4CafgcVW7sH 4A+iRmTMYrZpp5i/iKd+Gi5wyO6V04TBMnvbK579rqxsQJEnsn7ZzaQee8t0K7eA6y jPDvLFjgWAvV6USfK7nDQqjt3QHIky7ng7QUfXfC47leRaLQQTb4aNMXAyRfyuggIu JnpJFXyQF1ldw== 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 v24 4/5] mm/pagemap: add documentation of PAGEMAP_SCAN IOCTL Date: Tue, 11 Jul 2023 17:52:40 +0500 Message-Id: <20230711125241.1587820-5-usama.anjum@collabora.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230711125241.1587820-1-usama.anjum@collabora.com> References: <20230711125241.1587820-1-usama.anjum@collabora.com> MIME-Version: 1.0 X-Rspam-User: X-Stat-Signature: etq11abmn6w3atwwg9ebx9axzf1wqxyb X-Rspamd-Server: rspam07 X-Rspamd-Queue-Id: B7D45C0009 X-HE-Tag: 1689080028-528225 X-HE-Meta: U2FsdGVkX19qUva1bbz2RLY3s5eAFR1Mbcei8lj9fRNRrSpcykRA0013mGLldTlBf8zNRfMoJzloeN3RDSjdIxwnOIQ9TSs/W71beh/I8PwPW5yOI+RSI9hyPfoJfnVx4nDDj7nz48gOzefaud1xDX/PjxwjTbvUVrLZBY6uScqNyOYqlcr05RaYfwvOO49qrMnDtr322Q7ke6Yf41wi7sfwVlz/oUr2zeJ1UfFZqS7UCCVkBkWHHFAl44dSTsQ1Wrq2nJH31oDe/GTTDcwspfzKMpNt7Zd698GW2SpMUNILVsbwzwJIUE1l8+EOCMozj0aR/5QZbSWsbAL27TefSBfDwzrLnVejLqSmQVi6/Zs6f1LRAYrJvimGlmP5BDxHt0et+BNEQlv60lRdPO0vpJbC0YSqdDKk//R+Sz+H8ZwYecBSU2Ne0o5kPHYAl/0YHk4uhOYdZ0iaD0OsyDBaCxwr/Cg7+H8sXIlaBsMN1oZDeTLiuQ4SRnCwh5ywWVm/RGWilAnTSukuVlRzsy4xIqSVQMbOGcpm69HNOY1UJ7rAD2T5dGKxU8Xj2GpIsGacF8Y+Yl2t39d91ajLukbwXi2Nkm9AStObUrzR6vfrJ6eRd4pTDwzrIdUrHRg2BS1I6uY4lYjARpxJjj4UkEwNr3NijvhW97bAXDHhKnM03Joh71xM9bPlJWkK6pJl7y1DxLGxFfNjFm3sORJOtqogeN4SJsobFhLE9flzdVO3xfY54h3QzFjiT2Keg2QIk4ktAJ38mroc+M5DGCjqT3lI9K97fBFdjy0kDTa4t1LsOY2Mgr6hMJAIg13VwIxQLallE5WBufSwl+AM4SB+jAr9pOcEG6wvzCbAAWIp4yApwoP4qp3b5YFFN/UgkOgePeTKdBuLCyI2NWyySxEh+hQoK6m/OY3RmYd1e18JdeFtIn+gRO79EC/HElkktt9xoW5W/6l/wFNT1JOJfQ+8VGS s9gTQKqB OkqKaygZnHGSbwcr8I1/H634YXocyBDtHVuzGm0q4khU1CcwQw4P9ASWg3ZMGLcYIMxlxSfyr2u1KC7XIA8CyKMwUkzuu0L7QjTW1Q6kLWWk3Rc4YO4OIMY2QXXI2sauRHoUwBs5McJsISCZ68iqU7oLsS0yi/qdaz0OC+zl0EnNESSE7d7NjxtBnutVtzke4ZOtlxuXoGmOEHZFI/LKMxpJs5yaqo97nYLra3YvTqOGnNz9wF4jGMNcXioy8FwLeQ1pcY0o0gL5U000EKQdCNak1MoGCpFq3b5y6k96DYA4mQYo= 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 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.