From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.0 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE, SPF_PASS,USER_AGENT_SANE_1 autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id E9D9AC433DF for ; Wed, 8 Jul 2020 01:08:01 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 5EFE8206BE for ; Wed, 8 Jul 2020 01:08:01 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="3J9j+yby" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 5EFE8206BE Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id BB6CF8D0006; Tue, 7 Jul 2020 21:08:00 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id B67D98D0003; Tue, 7 Jul 2020 21:08:00 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id A564B8D0006; Tue, 7 Jul 2020 21:08:00 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0028.hostedemail.com [216.40.44.28]) by kanga.kvack.org (Postfix) with ESMTP id 8CAB18D0003 for ; Tue, 7 Jul 2020 21:08:00 -0400 (EDT) Received: from smtpin10.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay01.hostedemail.com (Postfix) with ESMTP id E8AE2180AD807 for ; Wed, 8 Jul 2020 01:07:59 +0000 (UTC) X-FDA: 77013121878.10.head06_170d10626eb9 Received: from filter.hostedemail.com (10.5.16.251.rfc1918.com [10.5.16.251]) by smtpin10.hostedemail.com (Postfix) with ESMTP id C0980169F9A for ; Wed, 8 Jul 2020 01:07:59 +0000 (UTC) X-HE-Tag: head06_170d10626eb9 X-Filterd-Recvd-Size: 28221 Received: from merlin.infradead.org (merlin.infradead.org [205.233.59.134]) by imf11.hostedemail.com (Postfix) with ESMTP for ; Wed, 8 Jul 2020 01:07:57 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=merlin.20170209; h=Content-Transfer-Encoding:Content-Type: MIME-Version:Date:Message-ID:Subject:From:Cc:To:Sender:Reply-To:Content-ID: Content-Description:In-Reply-To:References; bh=8jRIBWNGy9c23iQpeE8DZq/0IPw8iKPvSlGvT8kQI/0=; b=3J9j+ybyT+35mMAArGGUSn3lRI vwAHeUnsbN55FIlN+9qayxSF9ynJ+SL6i/gnQ+zGzUetsnYmp82ULB7AMWoa6jj17DjNfscGTuGTw TqUfwIM3XRuAzZjZPMC57qcmjgO64az0vDMn5PaMs9ISzOdaC5V5dvGdHlqD9r2TLAEw3gYIHn7TT 3L0vPAvWCn7ydR7NKFA0J0EiV+X/qpBqDXvA41leLcVjyZMtpeeMQq6v3G8nRxm8i15Pj4kHaEq50 SL5TqcpS/fiFVgvHGpMoL5oqESl0FlqNi7hq0nD3tDALu5CYnR+IAiVsv+i2u2OXnHCmE45jg7b6N 5edU40hw==; Received: from [2601:1c0:6280:3f0:897c:6038:c71d:ecac] by merlin.infradead.org with esmtpsa (Exim 4.92.3 #3 (Red Hat Linux)) id 1jsyYt-0000MT-CS; Wed, 08 Jul 2020 01:07:48 +0000 To: Linux MM , LKML , Andrew Morton , "linux-doc@vger.kernel.org" , Jonathan Corbet Cc: Anshuman Khandual , Mike Rapoport , "linux-arch@vger.kernel.org" From: Randy Dunlap Subject: [PATCH -next] Documentation/vm: fix tables in arch_pgtable_helpers Message-ID: <02ee60d0-e836-2237-4881-5c57ccac5551@infradead.org> Date: Tue, 7 Jul 2020 18:07:40 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.9.0 MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit X-Rspamd-Queue-Id: C0980169F9A X-Spamd-Result: default: False [0.00 / 100.00] X-Rspamd-Server: rspam01 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: From: Randy Dunlap Make the tables be presented as tables in the generated output files (the line drawing did not present well). Signed-off-by: Randy Dunlap Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.org Cc: Anshuman Khandual Cc: Mike Rapoport Cc: linux-arch@vger.kernel.org Cc: linux-mm@kvack.org Cc: Andrew Morton --- Documentation/vm/arch_pgtable_helpers.rst | 333 ++++++-------------- 1 file changed, 116 insertions(+), 217 deletions(-) --- linux-next-20200707.orig/Documentation/vm/arch_pgtable_helpers.rst +++ linux-next-20200707/Documentation/vm/arch_pgtable_helpers.rst @@ -17,242 +17,141 @@ test need to be in sync. PTE Page Table Helpers ====================== --------------------------------------------------------------------------------- -| pte_same | Tests whether both PTE entries are the same | --------------------------------------------------------------------------------- -| pte_bad | Tests a non-table mapped PTE | --------------------------------------------------------------------------------- -| pte_present | Tests a valid mapped PTE | --------------------------------------------------------------------------------- -| pte_young | Tests a young PTE | --------------------------------------------------------------------------------- -| pte_dirty | Tests a dirty PTE | --------------------------------------------------------------------------------- -| pte_write | Tests a writable PTE | --------------------------------------------------------------------------------- -| pte_special | Tests a special PTE | --------------------------------------------------------------------------------- -| pte_protnone | Tests a PROT_NONE PTE | --------------------------------------------------------------------------------- -| pte_devmap | Tests a ZONE_DEVICE mapped PTE | --------------------------------------------------------------------------------- -| pte_soft_dirty | Tests a soft dirty PTE | --------------------------------------------------------------------------------- -| pte_swp_soft_dirty | Tests a soft dirty swapped PTE | --------------------------------------------------------------------------------- -| pte_mkyoung | Creates a young PTE | --------------------------------------------------------------------------------- -| pte_mkold | Creates an old PTE | --------------------------------------------------------------------------------- -| pte_mkdirty | Creates a dirty PTE | --------------------------------------------------------------------------------- -| pte_mkclean | Creates a clean PTE | --------------------------------------------------------------------------------- -| pte_mkwrite | Creates a writable PTE | --------------------------------------------------------------------------------- -| pte_mkwrprotect | Creates a write protected PTE | --------------------------------------------------------------------------------- -| pte_mkspecial | Creates a special PTE | --------------------------------------------------------------------------------- -| pte_mkdevmap | Creates a ZONE_DEVICE mapped PTE | --------------------------------------------------------------------------------- -| pte_mksoft_dirty | Creates a soft dirty PTE | --------------------------------------------------------------------------------- -| pte_clear_soft_dirty | Clears a soft dirty PTE | --------------------------------------------------------------------------------- -| pte_swp_mksoft_dirty | Creates a soft dirty swapped PTE | --------------------------------------------------------------------------------- -| pte_swp_clear_soft_dirty | Clears a soft dirty swapped PTE | --------------------------------------------------------------------------------- -| pte_mknotpresent | Invalidates a mapped PTE | --------------------------------------------------------------------------------- -| ptep_get_and_clear | Clears a PTE | --------------------------------------------------------------------------------- -| ptep_get_and_clear_full | Clears a PTE | --------------------------------------------------------------------------------- -| ptep_test_and_clear_young | Clears young from a PTE | --------------------------------------------------------------------------------- -| ptep_set_wrprotect | Converts into a write protected PTE | --------------------------------------------------------------------------------- -| ptep_set_access_flags | Converts into a more permissive PTE | --------------------------------------------------------------------------------- +=========================== ================================================ +pte_same Tests whether both PTE entries are the same +pte_bad Tests a non-table mapped PTE +pte_present Tests a valid mapped PTE +pte_young Tests a young PTE +pte_dirty Tests a dirty PTE +pte_write Tests a writable PTE +pte_special Tests a special PTE +pte_protnone Tests a PROT_NONE PTE +pte_devmap Tests a ZONE_DEVICE mapped PTE +pte_soft_dirty Tests a soft dirty PTE +pte_swp_soft_dirty Tests a soft dirty swapped PTE +pte_mkyoung Creates a young PTE +pte_mkold Creates an old PTE +pte_mkdirty Creates a dirty PTE +pte_mkclean Creates a clean PTE +pte_mkwrite Creates a writable PTE +pte_mkwrprotect Creates a write protected PTE +pte_mkspecial Creates a special PTE +pte_mkdevmap Creates a ZONE_DEVICE mapped PTE +pte_mksoft_dirty Creates a soft dirty PTE +pte_clear_soft_dirty Clears a soft dirty PTE +pte_swp_mksoft_dirty Creates a soft dirty swapped PTE +pte_swp_clear_soft_dirty Clears a soft dirty swapped PTE +pte_mknotpresent Invalidates a mapped PTE +ptep_get_and_clear Clears a PTE +ptep_get_and_clear_full Clears a PTE +ptep_test_and_clear_young Clears young from a PTE +ptep_set_wrprotect Converts into a write protected PTE +ptep_set_access_flags Converts into a more permissive PTE +=========================== ================================================ ====================== PMD Page Table Helpers ====================== --------------------------------------------------------------------------------- -| pmd_same | Tests whether both PMD entries are the same | --------------------------------------------------------------------------------- -| pmd_bad | Tests a non-table mapped PMD | --------------------------------------------------------------------------------- -| pmd_leaf | Tests a leaf mapped PMD | --------------------------------------------------------------------------------- -| pmd_huge | Tests a HugeTLB mapped PMD | --------------------------------------------------------------------------------- -| pmd_trans_huge | Tests a Transparent Huge Page (THP) at PMD | --------------------------------------------------------------------------------- -| pmd_present | Tests a valid mapped PMD | --------------------------------------------------------------------------------- -| pmd_young | Tests a young PMD | --------------------------------------------------------------------------------- -| pmd_dirty | Tests a dirty PMD | --------------------------------------------------------------------------------- -| pmd_write | Tests a writable PMD | --------------------------------------------------------------------------------- -| pmd_special | Tests a special PMD | --------------------------------------------------------------------------------- -| pmd_protnone | Tests a PROT_NONE PMD | --------------------------------------------------------------------------------- -| pmd_devmap | Tests a ZONE_DEVICE mapped PMD | --------------------------------------------------------------------------------- -| pmd_soft_dirty | Tests a soft dirty PMD | --------------------------------------------------------------------------------- -| pmd_swp_soft_dirty | Tests a soft dirty swapped PMD | --------------------------------------------------------------------------------- -| pmd_mkyoung | Creates a young PMD | --------------------------------------------------------------------------------- -| pmd_mkold | Creates an old PMD | --------------------------------------------------------------------------------- -| pmd_mkdirty | Creates a dirty PMD | --------------------------------------------------------------------------------- -| pmd_mkclean | Creates a clean PMD | --------------------------------------------------------------------------------- -| pmd_mkwrite | Creates a writable PMD | --------------------------------------------------------------------------------- -| pmd_mkwrprotect | Creates a write protected PMD | --------------------------------------------------------------------------------- -| pmd_mkspecial | Creates a special PMD | --------------------------------------------------------------------------------- -| pmd_mkdevmap | Creates a ZONE_DEVICE mapped PMD | --------------------------------------------------------------------------------- -| pmd_mksoft_dirty | Creates a soft dirty PMD | --------------------------------------------------------------------------------- -| pmd_clear_soft_dirty | Clears a soft dirty PMD | --------------------------------------------------------------------------------- -| pmd_swp_mksoft_dirty | Creates a soft dirty swapped PMD | --------------------------------------------------------------------------------- -| pmd_swp_clear_soft_dirty | Clears a soft dirty swapped PMD | --------------------------------------------------------------------------------- -| pmd_mkinvalid | Invalidates a mapped PMD [1] | --------------------------------------------------------------------------------- -| pmd_set_huge | Creates a PMD huge mapping | --------------------------------------------------------------------------------- -| pmd_clear_huge | Clears a PMD huge mapping | --------------------------------------------------------------------------------- -| pmdp_get_and_clear | Clears a PMD | --------------------------------------------------------------------------------- -| pmdp_get_and_clear_full | Clears a PMD | --------------------------------------------------------------------------------- -| pmdp_test_and_clear_young | Clears young from a PMD | --------------------------------------------------------------------------------- -| pmdp_set_wrprotect | Converts into a write protected PMD | --------------------------------------------------------------------------------- -| pmdp_set_access_flags | Converts into a more permissive PMD | --------------------------------------------------------------------------------- +=========================== ================================================ +pmd_same Tests whether both PMD entries are the same +pmd_bad Tests a non-table mapped PMD +pmd_leaf Tests a leaf mapped PMD +pmd_huge Tests a HugeTLB mapped PMD +pmd_trans_huge Tests a Transparent Huge Page (THP) at PMD +pmd_present Tests a valid mapped PMD +pmd_young Tests a young PMD +pmd_dirty Tests a dirty PMD +pmd_write Tests a writable PMD +pmd_special Tests a special PMD +pmd_protnone Tests a PROT_NONE PMD +pmd_devmap Tests a ZONE_DEVICE mapped PMD +pmd_soft_dirty Tests a soft dirty PMD +pmd_swp_soft_dirty Tests a soft dirty swapped PMD +pmd_mkyoung Creates a young PMD +pmd_mkold Creates an old PMD +pmd_mkdirty Creates a dirty PMD +pmd_mkclean Creates a clean PMD +pmd_mkwrite Creates a writable PMD +pmd_mkwrprotect Creates a write protected PMD +pmd_mkspecial Creates a special PMD +pmd_mkdevmap Creates a ZONE_DEVICE mapped PMD +pmd_mksoft_dirty Creates a soft dirty PMD +pmd_clear_soft_dirty Clears a soft dirty PMD +pmd_swp_mksoft_dirty Creates a soft dirty swapped PMD +pmd_swp_clear_soft_dirty Clears a soft dirty swapped PMD +pmd_mkinvalid Invalidates a mapped PMD [1] +pmd_set_huge Creates a PMD huge mapping +pmd_clear_huge Clears a PMD huge mapping +pmdp_get_and_clear Clears a PMD +pmdp_get_and_clear_full Clears a PMD +pmdp_test_and_clear_young Clears young from a PMD +pmdp_set_wrprotect Converts into a write protected PMD +pmdp_set_access_flags Converts into a more permissive PMD +=========================== ================================================ ====================== PUD Page Table Helpers ====================== --------------------------------------------------------------------------------- -| pud_same | Tests whether both PUD entries are the same | --------------------------------------------------------------------------------- -| pud_bad | Tests a non-table mapped PUD | --------------------------------------------------------------------------------- -| pud_leaf | Tests a leaf mapped PUD | --------------------------------------------------------------------------------- -| pud_huge | Tests a HugeTLB mapped PUD | --------------------------------------------------------------------------------- -| pud_trans_huge | Tests a Transparent Huge Page (THP) at PUD | --------------------------------------------------------------------------------- -| pud_present | Tests a valid mapped PUD | --------------------------------------------------------------------------------- -| pud_young | Tests a young PUD | --------------------------------------------------------------------------------- -| pud_dirty | Tests a dirty PUD | --------------------------------------------------------------------------------- -| pud_write | Tests a writable PUD | --------------------------------------------------------------------------------- -| pud_devmap | Tests a ZONE_DEVICE mapped PUD | --------------------------------------------------------------------------------- -| pud_mkyoung | Creates a young PUD | --------------------------------------------------------------------------------- -| pud_mkold | Creates an old PUD | --------------------------------------------------------------------------------- -| pud_mkdirty | Creates a dirty PUD | --------------------------------------------------------------------------------- -| pud_mkclean | Creates a clean PUD | --------------------------------------------------------------------------------- -| pud_mkwrite | Creates a writable PMD | --------------------------------------------------------------------------------- -| pud_mkwrprotect | Creates a write protected PMD | --------------------------------------------------------------------------------- -| pud_mkdevmap | Creates a ZONE_DEVICE mapped PMD | --------------------------------------------------------------------------------- -| pud_mkinvalid | Invalidates a mapped PUD [1] | --------------------------------------------------------------------------------- -| pud_set_huge | Creates a PUD huge mapping | --------------------------------------------------------------------------------- -| pud_clear_huge | Clears a PUD huge mapping | --------------------------------------------------------------------------------- -| pudp_get_and_clear | Clears a PUD | --------------------------------------------------------------------------------- -| pudp_get_and_clear_full | Clears a PUD | --------------------------------------------------------------------------------- -| pudp_test_and_clear_young | Clears young from a PUD | --------------------------------------------------------------------------------- -| pudp_set_wrprotect | Converts into a write protected PUD | --------------------------------------------------------------------------------- -| pudp_set_access_flags | Converts into a more permissive PUD | --------------------------------------------------------------------------------- +=========================== ================================================ +pud_same Tests whether both PUD entries are the same +pud_bad Tests a non-table mapped PUD +pud_leaf Tests a leaf mapped PUD +pud_huge Tests a HugeTLB mapped PUD +pud_trans_huge Tests a Transparent Huge Page (THP) at PUD +pud_present Tests a valid mapped PUD +pud_young Tests a young PUD +pud_dirty Tests a dirty PUD +pud_write Tests a writable PUD +pud_devmap Tests a ZONE_DEVICE mapped PUD +pud_mkyoung Creates a young PUD +pud_mkold Creates an old PUD +pud_mkdirty Creates a dirty PUD +pud_mkclean Creates a clean PUD +pud_mkwrite Creates a writable PMD +pud_mkwrprotect Creates a write protected PMD +pud_mkdevmap Creates a ZONE_DEVICE mapped PMD +pud_mkinvalid Invalidates a mapped PUD [1] +pud_set_huge Creates a PUD huge mapping +pud_clear_huge Clears a PUD huge mapping +pudp_get_and_clear Clears a PUD +pudp_get_and_clear_full Clears a PUD +pudp_test_and_clear_young Clears young from a PUD +pudp_set_wrprotect Converts into a write protected PUD +pudp_set_access_flags Converts into a more permissive PUD +=========================== ================================================ ========================== HugeTLB Page Table Helpers ========================== --------------------------------------------------------------------------------- -| pte_huge | Tests a HugeTLB | --------------------------------------------------------------------------------- -| pte_mkhuge | Creates a HugeTLB | --------------------------------------------------------------------------------- -| huge_pte_dirty | Tests a dirty HugeTLB | --------------------------------------------------------------------------------- -| huge_pte_write | Tests a writable HugeTLB | --------------------------------------------------------------------------------- -| huge_pte_mkdirty | Creates a dirty HugeTLB | --------------------------------------------------------------------------------- -| huge_pte_mkwrite | Creates a writable HugeTLB | --------------------------------------------------------------------------------- -| huge_pte_mkwrprotect | Creates a write protected HugeTLB | --------------------------------------------------------------------------------- -| huge_ptep_get_and_clear | Clears a HugeTLB | --------------------------------------------------------------------------------- -| huge_ptep_set_wrprotect | Converts into a write protected HugeTLB | --------------------------------------------------------------------------------- -| huge_ptep_set_access_flags | Converts into a more permissive HugeTLB | --------------------------------------------------------------------------------- +============================ =============================================== +pte_huge Tests a HugeTLB +pte_mkhuge Creates a HugeTLB +huge_pte_dirty Tests a dirty HugeTLB +huge_pte_write Tests a writable HugeTLB +huge_pte_mkdirty Creates a dirty HugeTLB +huge_pte_mkwrite Creates a writable HugeTLB +huge_pte_mkwrprotect Creates a write protected HugeTLB +huge_ptep_get_and_clear Clears a HugeTLB +huge_ptep_set_wrprotect Converts into a write protected HugeTLB +huge_ptep_set_access_flags Converts into a more permissive HugeTLB +============================ =============================================== ======================== SWAP Page Table Helpers ======================== --------------------------------------------------------------------------------- -| __pte_to_swp_entry | Creates a swapped entry (arch) from a mapepd PTE | --------------------------------------------------------------------------------- -| __swp_to_pte_entry | Creates a mapped PTE from a swapped entry (arch) | --------------------------------------------------------------------------------- -| __pmd_to_swp_entry | Creates a swapped entry (arch) from a mapepd PMD | --------------------------------------------------------------------------------- -| __swp_to_pmd_entry | Creates a mapped PMD from a swapped entry (arch) | --------------------------------------------------------------------------------- -| is_migration_entry | Tests a migration (read or write) swapped entry | --------------------------------------------------------------------------------- -| is_write_migration_entry | Tests a write migration swapped entry | --------------------------------------------------------------------------------- -| make_migration_entry_read | Converts into read migration swapped entry | --------------------------------------------------------------------------------- -| make_migration_entry | Creates a migration swapped entry (read or write)| --------------------------------------------------------------------------------- +========================== ================================================= +__pte_to_swp_entry Creates a swapped entry (arch) from a mapepd PTE +__swp_to_pte_entry Creates a mapped PTE from a swapped entry (arch) +__pmd_to_swp_entry Creates a swapped entry (arch) from a mapepd PMD +__swp_to_pmd_entry Creates a mapped PMD from a swapped entry (arch) +is_migration_entry Tests a migration (read or write) swapped entry +is_write_migration_entry Tests a write migration swapped entry +make_migration_entry_read Converts into read migration swapped entry +make_migration_entry Creates a migration swapped entry (read or write) +========================== ================================================= [1] https://lore.kernel.org/linux-mm/20181017020930.GN30832@redhat.com/