From patchwork Wed Aug 16 11:30:48 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: 13355063 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 29E2DC001B0 for ; Wed, 16 Aug 2023 11:31:40 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 829D4280009; Wed, 16 Aug 2023 07:31:39 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 7DA1B8D0001; Wed, 16 Aug 2023 07:31:39 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 6C94F280009; Wed, 16 Aug 2023 07:31:39 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0015.hostedemail.com [216.40.44.15]) by kanga.kvack.org (Postfix) with ESMTP id 5D62C8D0001 for ; Wed, 16 Aug 2023 07:31:39 -0400 (EDT) Received: from smtpin10.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay03.hostedemail.com (Postfix) with ESMTP id 295E1A0F3A for ; Wed, 16 Aug 2023 11:31:39 +0000 (UTC) X-FDA: 81129752718.10.50CE3D5 Received: from madras.collabora.co.uk (madras.collabora.co.uk [46.235.227.172]) by imf10.hostedemail.com (Postfix) with ESMTP id 44271C0005 for ; Wed, 16 Aug 2023 11:31:36 +0000 (UTC) Authentication-Results: imf10.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=G+tzRsRT; 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=1692185497; 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=PPGJ+KGWviPQTn3XP+5D2RgTXyx1L3B6OcmlsNFGtCc=; b=PWeodHLW/f4zR2Jcdnqy3DmnQrd0u0srBlo8DGlN/cxli3Q41CEbWkwyrx2Vy2V3bwS/yx qF+mman59bgoJK4J+XKwOJ5eBx1C33m4Vxau1RXOrijBWx/nNhENfV1F5sTGb0wBBYl9lr UP8rLKhWh+GKbLcMVHZK25im4bB3ZUk= ARC-Authentication-Results: i=1; imf10.hostedemail.com; dkim=pass header.d=collabora.com header.s=mail header.b=G+tzRsRT; 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=1692185497; a=rsa-sha256; cv=none; b=eTheBS28S3d76HF5WSZO8snAfdAyGw73rwB5P/6fRoe9RgpKJMmXlGK8IvJEE2Morm52Km uqhyCt5HDEv9cN4tDdcLMY2AoO/xb9CkbwwbhF0PvyQ995NVrzAoHcwMWWMIN3dQZ216IE utN5fLaGeUvFUUEHbxf4jRBBa+LhlbE= Received: from localhost.localdomain (unknown [59.103.216.185]) (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 A42FD6607204; Wed, 16 Aug 2023 12:31:29 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=collabora.com; s=mail; t=1692185496; bh=++7ZMwIn+CSvHBOzFMinKuXCGuCZi9t/HjmM0x59zug=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=G+tzRsRTLPsNY1r/xmhpjcBwYcDzsFkNWkC22UAyZeYgSS8hQJGErw3DJASu/u79z smxwydrB1oY5d0kDruvbUGZhirQiMEwK5gtP5bGmTumoSkyqUK3muTvgdvyRzHibXW SFRay0iR4XMxGWTd6eMEgHlNilP26ZCvXyWeoB49gBed4xCy92EqLEcutlb4ecWoBg x+dg8BFB8MiWNPs7s+Tqofz+Q0hwEoUue1sKpPMx3ixzoT/71NhQT7oLhCcuDHbHTQ RbAMF6rRAM+WbdHySgeuZ6p4JGKmoO+UVebX6Z54P/ptCKvvvfNiv72nBhkQdCRUiu z3Ue9n8MqRJlw== From: Muhammad Usama Anjum To: Peter Xu , Andrew Morton , =?utf-8?b?TWljaGHFgiBNaXJvc8WCYXc=?= , Andrei Vagin , Danylo Mocherniuk , Paul Gofman 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, Cyrill Gorcunov , Mike Rapoport , Nadav Amit , David Hildenbrand Subject: [PATCH v32 5/6] mm/pagemap: add documentation of PAGEMAP_SCAN IOCTL Date: Wed, 16 Aug 2023 16:30:48 +0500 Message-Id: <20230816113049.1697849-6-usama.anjum@collabora.com> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20230816113049.1697849-1-usama.anjum@collabora.com> References: <20230816113049.1697849-1-usama.anjum@collabora.com> MIME-Version: 1.0 X-Rspamd-Queue-Id: 44271C0005 X-Rspam-User: X-Rspamd-Server: rspam04 X-Stat-Signature: rrnejgk1iiiuhz4wsttaqkdso1cohqmz X-HE-Tag: 1692185496-272302 X-HE-Meta: U2FsdGVkX187d+3RwkbsbW59lJ8zbfT9WGQAMuewPdkZNL+ilobdolqT0obPonvfQMByIaz7x0isam6EJEBgdL+/nbLQDhQYOqNhh18x5MsEyBVYnCMpPgWimHIMo9Xkwy0ncBTK4KwsKa4jIPO9A6YvEpkT61v4LwLTyVKCL1xdv7LWMEJuEyL5mgaFdq6VndqcXtGPs5F3T+WoPM/uvYoKM4SL70TM8ZGmUiBkW15QHyVT2JoJPhdazKLwIn8Lj1mBSgpXn9ga/X6Ps8jBW8egq5StOyggn3Fk3PPSkEuMiWLJLm5PaRV/fRfUdrXV6pYRJ66QsvKs488wiHd0rkg3HHQb61Bx6/LlUx7S8PGmZkKe+GYRH7USW4ge9IOZ8Pw/v6qU1TI7LFpBrgZU2tc0d1C30VSANUT2Z/7vjG9jCFDxp77RWPt1L9zJG/3zk6NLi4+6RNIAo+yPCABTOdw1vE6jHz1J9kNwgUlYg8vOXEknUCKsiOS2BsVNxWnywSRyZVEwGN8r8kg+emDHEd8Et3gx3Rh0KmQ1x8M28H0L7w5QPyLVg41Eos7WXYaS2VoTaLT9y0/fm4gbFXYhWBc25qIi5xl3gwoNQZU/+ieoar5Kqkz4ocGsKwkcEejy/IGWRYKLqnyaJEitWl+veQsur9VGCwVEzU2PaozJyv+IqsonAZhgUM7Mvh5irjP1nMx3EN4bim/OUCoAMXHTWQEzgQO3s2dlb0BQgLj+ijW4aspveTjcE3wRCYfOkQBFrP7xhnMJloYdS34gujzmGijNQXCSkigpUVOOtt78GGtuKYCq5tLcvQksDK3/dJJQZ7U/ekE0iHq70InDf/mYMQ5Bs/Ne977RhLkg1cRz/i1qvw3+gLFARBcoPylM+lkzqYr8w02H/DC3NkMBvhyjBIKUD+GOTg1qEV2GccHBunQ5QrRcOFpLWQAxAwqpq+VIEje1+0177tHzR7eTSfJ Fwm38EM7 wCdpm0PhJSV1TKKgzbuLD3Oyo5BSxqXHhciA/a0ND+dLLqKonwi49CyNTI5jbLnxwh+Gbw9s++O54slKtmGcU1Jy58m078pOOHHO5V1T6DNcXAtcTR5dREbx9npOaJatLJ4iP10b6ZjUKbqdALsidcAPR81Ot56Q0XIKHrh9EY9d+Lk6eMoBV3soXbA3kvKWPYizJQbG2g26En/+YNtL+o6F4v2j4pTSj8yDnr4lz2Yis3fzJsIMrW1RaebvY6SWXY1xsM7xa9SBPvhxZU/l8RZmo//nKPkME36xq1la5sHhuvjI= 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 v30: - Minor changes Changes in v29: - Revamp the documentation and make it better Changes in v26: - Update documentation according to latest revision 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 --- Documentation/admin-guide/mm/pagemap.rst | 89 ++++++++++++++++++++++++ 1 file changed, 89 insertions(+) diff --git a/Documentation/admin-guide/mm/pagemap.rst b/Documentation/admin-guide/mm/pagemap.rst index c8f380271cad8..fe17cf2104265 100644 --- a/Documentation/admin-guide/mm/pagemap.rst +++ b/Documentation/admin-guide/mm/pagemap.rst @@ -227,3 +227,92 @@ 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: + +- Scan the address range and get the memory ranges matching the provided criteria. + This is performed when the output buffer is specified. +- Write-protect the pages. The ``PM_SCAN_WP_MATCHING`` is used to write-protect + the pages of interest. The ``PM_SCAN_CHECK_WPASYNC`` aborts the operation if + non-Async Write Protected pages are found. The ``PM_SCAN_WP_MATCHING`` can be + used with or without ``PM_SCAN_CHECK_WPASYNC``. +- Both of those operations can be combined into one atomic operation where we can + get and write protect the pages as well. + +Following flags about pages are currently supported: + +- ``PAGE_IS_WPALLOWED`` - Page has async-write-protection enabled +- ``PAGE_IS_WRITTEN`` - Page has been written to from the time it was write protected +- ``PAGE_IS_FILE`` - Page is file backed +- ``PAGE_IS_PRESENT`` - Page is present in the memory +- ``PAGE_IS_SWAPPED`` - Page is in swapped +- ``PAGE_IS_PFNZERO`` - Page has zero PFN +- ``PAGE_IS_HUGE`` - Page is THP or Hugetlb backed + +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_WP_MATCHING`` + and ``PM_SCAN_CHECK_WPASYNC`` are the only added flags at this time. The get + operation is optionally performed depending upon if the output buffer is + provided or not. + 3. The range is specified through ``start`` and ``end``. + 4. The walk can abort before visiting the complete range such as the user buffer + can get full etc. The walk ending address is specified in``end_walk``. + 5. The output buffer of ``struct page_region`` array and size is specified in + ``vec`` and ``vec_len``. + 6. The optional maximum requested pages are specified in the ``max_pages``. + 7. The masks are specified in ``category_mask``, ``category_anyof_mask``, + ``category_inverted`` and ``return_mask``. + +Find pages which have been written and WP them as well:: + + struct pm_scan_arg arg = { + .size = sizeof(arg), + .flags = PM_SCAN_CHECK_WPASYNC | PM_SCAN_CHECK_WPASYNC, + .. + .category_mask = PAGE_IS_WRITTEN, + .return_mask = PAGE_IS_WRITTEN, + }; + +Find pages which have been written, are file backed, not swapped and either +present or huge:: + + struct pm_scan_arg arg = { + .size = sizeof(arg), + .flags = 0, + .. + .category_mask = PAGE_IS_WRITTEN | PAGE_IS_SWAPPED, + .category_inverted = PAGE_IS_SWAPPED, + .category_anyof_mask = PAGE_IS_PRESENT | PAGE_IS_HUGE, + .return_mask = PAGE_IS_WRITTEN | PAGE_IS_SWAPPED | + PAGE_IS_PRESENT | PAGE_IS_HUGE, + }; + +The ``PAGE_IS_WRITTEN`` flag can be considered as a better-performing alternative +of soft-dirty flag. It doesn't get affected by VMA merging of the kernel and hence +the user can find the true soft-dirty pages in case of normal pages. (There may +still be extra dirty pages reported for THP or Hugetlb pages.) + +"PAGE_IS_WRITTEN" category is used with uffd write protect-enabled ranges to +implement memory dirty tracking in userspace: + + 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_WP_MATCHING`` + 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 since they were last marked and/or optionally write protect + the pages as well.